Skip to content

Commit

Permalink
Docs: Add CONTRIBUTING.md with guildlines for contributing to the pro…
Browse files Browse the repository at this point in the history
…ject
  • Loading branch information
LifeAdventurer committed Oct 2, 2024
1 parent ecc3c5c commit 720ee86
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing to Typing Contest Discord Bot

Thank you for your interest in contributing to the Typing Contest Discord Bot! Contributions of all types are welcomed, including bug reports, feature requests, code improvements, and documentation updates.

## How to Contribute

### 1. Reporting Issues

If you encounter any issues or bugs, please report them by creating a new issue in the repository. Be sure to include:

- A clear description of the problem.
- Steps to reproduce the issue.
- Any error messages or screenshots, if applicable.

### 2. Feature Requests

If you have an idea for a new feature, please open an issue to discuss it before implementing it. Include:

- A brief description of the feature.
- The problem it solves or the value it adds.

### 3. Code Contributions

Once your feature request has been discussed and approved, you can start working on it. When you're ready to submit your changes:

- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and ensure that your code follows the project's coding style.
- Use pre-commit hooks to format and lint your code.
- Run the bot in debug mode using the command: `python main.py --debug` to ensure no bugs are introduced.
- Commit your changes.
- Push to your branch.
- Open a pull request, clearly explaining your changes.

Thank you for helping to improve the Typing Contest Discord Bot! Your contributions are greatly appreciated.

Happy Coding!
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ python main.py # Or `poetry run python main.py` if using Poetry
- `!getrole`: Assign yourself the typist role.
- `!commands`: Show this list of commands.

## Contributing

Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on contributing to this project.

## License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [`LICENSE`](./LICENSE) file for details.
Expand Down

0 comments on commit 720ee86

Please sign in to comment.