Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.22 KB

Contributing to Chessmate ♟️

Thank you for considering contributing to Chessmate! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. Please read the following guidelines to ensure a smooth contribution process.

Table of Contents

Getting Started

To get started with contributing:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine: 
    https://github.com/satyamgupta1495/chess-mate.git
  3. Create a new branch for your changes: 
    git checkout -b feature-or-bugfix-name
  4. Follow the Installation steps in the main README.md file to set up the project on your local machine.

How to Contribute

Reporting Bugs

If you find a bug, please report it by creating an issue in the GitHub Issues section. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue in the GitHub Issues section. Describe the enhancement in detail, including why it would be useful and how it should work.

Submitting Code Changes

  1. Ensure your code follows the project's coding standards and is well-documented.
  2. Commit your changes with a descriptive commit message: 
    git commit -m "Description of the changes"
  3. Push your changes to your forked repository: 
    git push origin feature-or-bugfix-name
  4. Create a pull request from your branch to the main branch of the original repository. Provide a detailed description of your changes in the pull request.

License

By contributing to Chessmate, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!

Chessmate Team