Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (51 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

74 lines (51 loc) · 2.4 KB

Contribution Guidelines

Thank you for considering contributing to bekind.! We welcome contributions that help improve the project and foster kindness in the community. Please take a moment to review these guidelines to ensure a smooth collaboration.

How Can You Contribute?

Reporting Bugs

If you encounter a bug, please open an issue with:

  1. A clear and descriptive title.
  2. Steps to reproduce the issue.
  3. Expected and actual behavior.
  4. Screenshots or error logs, if applicable.
  5. Your environment (e.g., operating system, browser, Node.js version).

Suggesting Features

We’re always looking to make bekind. better! To suggest a feature:

  1. Open a feature request issue.
  2. Describe the feature and its purpose.
  3. If possible, suggest how it might be implemented.

Improving Documentation

Documentation improvements are always appreciated. You can:

  1. Fix typos or improve clarity in existing docs.
  2. Add new documentation for features, setup, or usage.
  3. Suggest updates for outdated information.

Submitting Code

If you’re ready to contribute code, here’s how:

  1. Fork the repository: Create your own copy of the repository by clicking the Fork button.
  2. Clone your fork: Clone your forked repository to your local machine. 
    git clone https://github.com/kaseax/bekind.git
  3. Create a branch: Create a new branch for your changes. 
    git checkout -b feat/feature-name or fix/bug-name
  4. Make changes: Commit your code with clear commit messages. 
    git commit -m "feat: Description of feature"
  5. Push changes: Push your changes to your fork. 
    git push origin feat/feature-name or fix/bug-name
  6. Submit a pull request (PR): Open a pull request to the main repository.

Pull Request Guidelines

  • Adhere to the existing code style and format.
  • Include detailed descriptions in your PR about what you’ve changed and why.
  • Reference the related issue if applicable.

Code Style

We follow standard JavaScript conventions and encourage clean, readable code. Run npm run lint to check for style issues before submitting your code.

Getting Help

If you have questions or need help, feel free to:

Thank you for helping make bekind. a better project for everyone!