-
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
1 parent
d2962dc
commit 1e31abf
Showing
1 changed file
with
27 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,27 @@ | ||
# Contributing Guidelines | ||
|
||
Thank you for your interest in contributing to our project! We welcome contributions from everyone. | ||
To maintain a welcoming and collaborative environment, please review and follow these guidelines when contributing. | ||
|
||
## Ways to Contribute | ||
|
||
There are two ways you can contribute to this project: | ||
|
||
1. Reporting Bugs: If you encounter any issues or bugs while using the script, please open an issue on the repository's issue tracker. | ||
2. Submitting Pull Requests: If you would like to contribute code or fixes, you can submit a pull request. Please make sure to follow the guidelines below. | ||
|
||
## Pull Request Guidelines | ||
|
||
1. **Fork** the repository and create your branch from `main`. | ||
|
||
3. Make sure your code adheres to the existing coding style and conventions. | ||
4. Write clear, concise commit messages. | ||
5. If your contribution introduces new functionality, make sure to include appropriate documentation and/or update existing documentation. | ||
6. Test your changes thoroughly to ensure they do not introduce any regressions. | ||
7. Ensure your code passes any automated test (shellcheck) | ||
8. Make sure your pull request title and description clearly explain the purpose and scope of the changes. | ||
|
||
## Getting Help | ||
|
||
If you have any questions or need further assistance, feel free to reach out to the project maintainers through the issue tracker. | ||
Thank you for contributing to this project! |