Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aahan0511 committed Dec 31, 2024
1 parent 580be0a commit 2c80b11
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 1 deletion.
47 changes: 47 additions & 0 deletions .github/CONTRIBUTING.md
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!
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,17 @@ Othello is licensed under the [**CC0 1.0 Universal License**](https://github.com
<br><br>
<div align="center">

# [**`Contributing`**](https://github.com/a-tesseract/Othello/blob/main/.github/CONTRIBUTING.md "Contributing on Othello")

</div>

Follow the [CONTRIBUTING.md](https://github.com/a-tesseract/Othello/blob/main/.github/CONTRIBUTING.md "Contributing for Othello") to ensure a smooth contribution process.

<br><br>
<div align="center">

# [**`Code Of Conduct`**](https://www.contributor-covenant.org/ "Contributor Covenant Website")

</div>

Othello is licensed under the [**Contributor Covenant Code of Conduct**](hhttps://github.com/a-tesseract/Othello/blob/main/.github/CODE_OF_CONDUCT.md "Code Of Conduct for Othello").
Othello has the [**Contributor Covenant Code of Conduct**](https://github.com/a-tesseract/Othello/blob/main/.github/CODE_OF_CONDUCT.md "Code Of Conduct for Othello").

0 comments on commit 2c80b11

Please sign in to comment.