-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Adding initial guide for contributors
- Loading branch information
1 parent
e306b93
commit 42e799b
Showing
1 changed file
with
29 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,29 @@ | ||
# Contributing to this repository | ||
|
||
Thank you for considering contributing to **Bug Buster**! We welcome contributions of all kinds, including bug reports, feature requests, code contributions, and documentation improvements. | ||
|
||
# How to Contribute | ||
|
||
## Reporting Bugs | ||
|
||
1. Ensure the bug was not already reported by searching under Issues. | ||
2. Open a new issue with a clear and descriptive title and include as much relevant information as possible. Include screenshots or code snippets, if applicable. | ||
|
||
## Suggesting Features | ||
|
||
1. Check the Issues to see if a similar feature has already been requested. | ||
2. If not, open a new issue and provide a clear and concise description of the feature, explaining why it would be useful and how it should function. | ||
|
||
## Code Contributions | ||
|
||
1. Create your fork from our repo. | ||
2. Create a new branch specific to the feature or bugfix you will work on. | ||
3. Implement your changes and test it locally. | ||
4. Ensure that the modifications are documented in the README.md or other relevant documentation files, when applicable. | ||
5. Commit your changes with clear and concise commit messages. | ||
6. Push the changes to remote and open a PR to the forked repo. | ||
7. Wait for feedback from reviewers. | ||
|
||
# Community and Support | ||
|
||
Join our community discussions on [Telegram](https://t.me/+G_CPMEhCHC04MzA5). |