Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SunilBoopalan authored Dec 14, 2021
1 parent 8e305ff commit def96db
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Hi, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to the Quantum Chess Project. These are the guidelines we request you to follow while contributing. Use your best judgment, and feel free to propose changes to this document in a pull request. When contributing to this repository, please first discuss the change you wish to make via an issue, a message on the slack channel, or any other method with the admin of this repository before making a change.

## Components:

* Board
* Pieces
* Quantum moves

## How can I contribute?

* Pull requests
* Report bugs
* Suggest enhancements to the code

## While suggesting enhancements:

* Use a clear and descriptive title for the issue to identify the suggestion.
* Provide a step-by-step description of the suggested enhancements in as many details as possible.
* Explain why this enhancement would be useful.

## Note:

When submitting a pull request, please make sure your code runs without bugs/errors and it is readable.


0 comments on commit def96db

Please sign in to comment.