From a2223f46bd3bd6bcebfa447d273823952eb7d85d Mon Sep 17 00:00:00 2001 From: Lars Date: Tue, 10 Sep 2024 11:48:08 +0200 Subject: [PATCH] feat(github): :sparkles: add contributing doc --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aed87fd --- /dev/null +++ b/CONTRIBUTING.md @@ -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.