-
Notifications
You must be signed in to change notification settings - Fork 2
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
1 parent
64e7bca
commit b2b8fb1
Showing
2 changed files
with
45 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,43 @@ | ||
# Contributing to rjq | ||
|
||
First off, thank you for considering contributing to rjq! 🎉 We appreciate your interest and effort in improving our project. | ||
|
||
## How to Contribute | ||
|
||
### Reporting Issues | ||
|
||
1. **Check Existing Issues**: Before creating a new issue, please check the [issue tracker](https://github.com/mainak55512/rjq/issues) to see if your issue has already been reported. | ||
2. **Create a New Issue**: If your issue is new, [open a new issue](https://github.com/mainak55512/rjq/issues/new) and provide as much detail as possible. Include: | ||
- A clear and descriptive title | ||
- A description of the problem or enhancement | ||
- Steps to reproduce the issue (if applicable) | ||
- Any relevant screenshots or error messages | ||
|
||
### Contributing Code | ||
|
||
1. **Fork the Repository**: Create a fork of the repository by clicking the "Fork" button at the top right of the repository page. | ||
2. **Clone Your Fork**: Clone your fork to your local machine using: | ||
```bash | ||
git clone https://github.com/mainak55512/rjq.git | ||
``` | ||
3. **Create a Branch**: Create a new branch for your changes: | ||
```bash | ||
git checkout -b your-branch-name | ||
``` | ||
4. **Make Changes**: Make your changes to the codebase. Ensure your changes follow the existing code style and conventions. | ||
5. **Commit Changes**: Commit your changes with a clear and descriptive commit message: | ||
```bash | ||
git add . | ||
git commit -m "Description of your changes" | ||
``` | ||
6. **Push Changes**: Push your changes to your forked repository: | ||
```bash | ||
git push origin your-branch-name | ||
``` | ||
7. **Create a Pull Request**: Go to the [Pull Requests](https://github.com/mainak55512/rjq/pulls) page of the original repository and click "New Pull Request." Select your branch and provide a description of your changes. | ||
|
||
|
||
If you have any questions or need help, feel free to open an issue or reach out to us! | ||
|
||
Thank you for contributing! | ||
|
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