-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
57 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Contributing to Othello | ||
|
||
Thank you for considering contributing to Othello! Your help is greatly appreciated. Please follow these guidelines to ensure a smooth contribution process. | ||
|
||
## How to Contribute | ||
|
||
1. **Fork the repository**: Create a personal fork of the project on GitHub. | ||
2. **Clone your fork**: Clone your forked repository to your local machine. | ||
```sh | ||
git clone https://github.com/your-username/Othello.git | ||
``` | ||
3. **Create a branch**: Create a new branch for your changes. | ||
```sh | ||
git checkout -b feature/your-feature-name | ||
``` | ||
4. **Make changes**: Implement your changes in the new branch. | ||
5. **Commit changes**: Commit your changes with a clear and concise commit message. | ||
```sh | ||
git commit -m "Add feature: your feature description" | ||
``` | ||
6. **Push to GitHub**: Push your changes to your forked repository. | ||
```sh | ||
git push origin feature/your-feature-name | ||
``` | ||
7. **Create a Pull Request**: Open a pull request to the main repository. Provide a detailed description of your changes. | ||
|
||
## Code Style | ||
|
||
- Follow the existing code style and conventions. | ||
- Write clear and concise comments where necessary. | ||
- Ensure your code is well-documented. | ||
|
||
## Testing | ||
|
||
- Write tests for your changes if applicable. | ||
- Ensure all tests pass before submitting your pull request. | ||
|
||
## Reporting Issues | ||
|
||
- If you find a bug or have a feature request, please open an issue on GitHub. | ||
- Provide as much detail as possible, including steps to reproduce the issue. | ||
|
||
## Code of Conduct | ||
|
||
Please adhere to the [Code of Conduct](https://github.com/a-tesseract/Othello/blob/main/.github/CODE_OF_CONDUCT.md) in all your interactions with the project. | ||
|
||
Thank you for contributing to Othello! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters