Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 3.02 KB
Raw

Contributing to Chess But Better

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Chess But Better. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. License

Code of Conduct

We expect all contributors to adhere to a code of conduct that promotes a respectful and collaborative environment for everyone involved in the Chess But Better project. This includes:

  • Respect: Treat others with kindness, empathy, and understanding. Respect diverse perspectives, experiences, and backgrounds.

  • Collaboration: Work together in a constructive and supportive manner. Offer assistance and guidance to fellow contributors.

  • Constructive Feedback: Encourage providing feedback in a constructive and considerate manner, focusing on improving the project rather than criticizing individuals.

If you encounter behavior that violates this code of conduct, please address it promptly by reaching out to project maintainers. Let's build a community where everyone feels welcome and valued.

How Can I Contribute?

Issues

  • Open your branch through GitHub's issue development section to link the branch to the relevant issue. This help maintain traceability and organization in the project's repository.

Reporting Bugs

  • Before creating bug reports, please check if the issue has already been reported.
  • When creating a bug report, please include as many details as possible. Fill out the bug report template.

Suggesting Enhancements

  • Before creating enhancement suggestions, please check if the enhancement has already been suggested.
  • When creating an enhancement suggestion, please include as many details as possible. Fill out the enhancement template.

Pull Requests

  • Ensure your code works and follows the project's styleguides.
  • Provide a clear and descriptive title for your pull request that summarizes the changes made.
  • Include a detailed description of the problem your pull request solves and the approach taken to solve it.
  • Ensure all tests pass and add any new tests if necessary to maintain code quality and prevent regressions.
  • Address any feedback or review comments promptly to facilitate the merging process.

Development Setup

  1. Clone the repository: git clone https://github.com/Ido-Barnea/Chess-But-Better.git
  2. Install dependencies: npm ci
  3. Run the application: npm run dev

License

By contributing to Chess But Better, you agree that your contributions will be licensed under the Apache-2.0 License.