Skip to content

Commit

Permalink
Merge pull request #56 from Supporterino/Supporterino-patch-12
Browse files Browse the repository at this point in the history
feat(github): ✨ add contributing doc
  • Loading branch information
Supporterino authored Sep 10, 2024
2 parents 42cfaab + a2223f4 commit 80cd76c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
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.

0 comments on commit 80cd76c

Please sign in to comment.