-
Notifications
You must be signed in to change notification settings - Fork 0
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
Showing
2 changed files
with
97 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,93 @@ | ||
### **`CONTRIBUTING.md`** | ||
|
||
# Contributing to AWS JSON Term Matcher | ||
|
||
Thank you for considering contributing to `aws_json_term_matcher`! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. We welcome contributions of all kinds, including bug reports, feature suggestions, code improvements, and documentation updates. | ||
|
||
--- | ||
|
||
## How to Contribute | ||
|
||
### 1. Fork the Repository | ||
|
||
Start by forking the repository: | ||
|
||
1. Navigate to the repository on GitHub: [aws_json_term_matcher](https://github.com/localstack/aws-json-term-matcher.git) | ||
2. Click the **Fork** button in the top-right corner of the page. | ||
|
||
### 2. Clone the Fork | ||
|
||
Clone your forked repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/localstack/aws-json-term-matcher.git | ||
cd aws_json_term_matcher | ||
``` | ||
|
||
### 3. Create a Branch | ||
|
||
Create a new branch for your changes: | ||
|
||
```bash | ||
git checkout -b feature/my-feature | ||
``` | ||
|
||
### 4. Make Changes | ||
|
||
- Ensure all changes adhere to the existing code style. | ||
- Add tests for any new functionality in the `tests` folder. | ||
- Update documentation in the `README.md` if necessary. | ||
|
||
### 5. Run Tests | ||
|
||
Run the test suite to verify your changes don’t break anything: | ||
|
||
```bash | ||
pytest | ||
``` | ||
|
||
Make sure all tests pass before submitting your contribution. | ||
|
||
### 6. Commit and Push | ||
|
||
Commit your changes with a clear and concise commit message: | ||
|
||
```bash | ||
git add . | ||
git commit -m "Add feature: my-feature" | ||
git push origin feature/my-feature | ||
``` | ||
|
||
### 7. Open a Pull Request | ||
|
||
Go to the original repository on GitHub and open a pull request: | ||
|
||
1. Navigate to the **Pull Requests** tab. | ||
2. Click **New Pull Request**. | ||
3. Select your fork and branch as the source, and the main repository as the target. | ||
4. Write a clear description of the changes in the pull request. | ||
5. Submit your pull request for review. | ||
|
||
|
||
## Reporting Issues | ||
|
||
If you encounter bugs, have suggestions, or want to request features: | ||
|
||
1. Check the [issues](https://github.com/localstack/aws-json-term-matcher/issues) to see if someone else has already reported it. | ||
2. If not, create a new issue with: | ||
- A descriptive title. | ||
- Steps to reproduce (for bugs). | ||
- Any additional details that could help. | ||
|
||
--- | ||
|
||
## Community Guidelines | ||
|
||
- Be respectful of others' contributions. | ||
- Review open pull requests if you have expertise. | ||
- Ask questions or suggest improvements in the issues section. | ||
|
||
--- | ||
|
||
Thank you for contributing to `aws_json_term_matcher`! 😊 | ||
|
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