Skip to content

Create CONTRIBUTING.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yanjustino merged 1 commit into from
Mar 8, 2025
Merged

Create CONTRIBUTING.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Loading