From 69c79707e61b2eb87f3bab3a7b510eb5c6acfacb Mon Sep 17 00:00:00 2001 From: Yan Justino Date: Sat, 8 Mar 2025 16:08:25 -0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..76a8ff8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing to GherXUnit + +Thank you for considering contributing to GherXUnit! Your contributions are highly valued and help us improve this project. Here are some guidelines to help you get started: + +## How to Contribute + +### Reporting Bugs +1. Check if the issue has already been reported. +2. Open a new issue and provide detailed information: + - Describe the problem clearly. + - Include steps to reproduce the issue. + - Provide your environment details (OS, platform, version). + +### Suggesting Enhancements +1. Ensure the feature doesn’t already exist. +2. Open a new issue and provide: + - A clear and descriptive title. + - A detailed description of the enhancement. + - Reasons why this would be useful. + +### Submitting Pull Requests +1. Fork the repository. +2. Create a new branch (`feature/your-feature-name`). +3. Make your changes. +4. Write clear and descriptive commit messages. +5. Push to your fork and submit a pull request. +6. Ensure your code passes existing tests and add new tests if needed. + +### Coding Standards +- Follow the coding style used in the project. +- Write unit tests for new functionality. +- Ensure your code is well-documented. + +## Code of Conduct +By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). + +## Additional Resources +- [GitHub Docs: Setting guidelines for repository contributors](https://github.com/github/docs/blob/9c45512e4744f81612875f873dbc10e3a3c26e08/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md) +- [GitHub Docs: Using templates to encourage useful issues and pull requests](https://github.com/github/docs/blob/9c45512e4744f81612875f873dbc10e3a3c26e08/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests.md)