-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add CONTRIBUTING.md with guildlines for contributing to the pro…
…ject
- Loading branch information
1 parent
ecc3c5c
commit 720ee86
Showing
2 changed files
with
40 additions
and
0 deletions.
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,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! |
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