-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #56 from Supporterino/Supporterino-patch-12
feat(github): ✨ add contributing doc
- Loading branch information
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 @@ | ||
## Reporting Issues | ||
|
||
If you encounter any bugs, issues, or have feature requests, please [open an issue](https://github.com/Supporterino/truenas-graphite-to-prometheus/issues) on GitHub. Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots. | ||
|
||
## Submitting Pull Requests | ||
|
||
1. Ensure your branch is up to date with the main repository's `main` branch. | ||
```sh | ||
git fetch upstream | ||
git checkout main | ||
git merge upstream/main | ||
``` | ||
2. Follow the [Coding Standards](#coding-standards) and ensure your code passes all tests. | ||
3. Create a detailed pull request description, including the purpose of the changes and any relevant information. | ||
4. Link any related issues in the pull request description. | ||
5. Wait for a project maintainer to review your pull request. Be prepared to make any requested changes. | ||
|
||
## Coding Standards | ||
|
||
- Follow the existing code style and conventions. | ||
- Write clear, concise, and well-documented code. | ||
- Use meaningful variable and function names. | ||
- Ensure your code is properly formatted. | ||
|
||
## Documentation | ||
|
||
- Update the README.md file if your changes affect the usage or setup of the project. | ||
- Add or update comments in the code to explain complex logic or important sections. | ||
- Ensure any new features or changes are documented in the appropriate markdown files. |