Skip to content

Commit

Permalink
Added contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
Naapperas committed Nov 26, 2023
1 parent 5e4dc74 commit 86e0436
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 1 deletion.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# `zon` Contribution Guidelines

This document contains the contribution guidelines for the `zon` project. All contributions will be welcome, but they should follow the guidelines described in this document.

## Table of Contents

- [`zon` Contribution Guidelines](#zon-contribution-guidelines)
- [Table of Contents](#table-of-contents)
- [Code of Conduct](#code-of-conduct)
- [Issues](#issues)
- [Pull Requests](#pull-requests)

## Code of Conduct

This project adheres to the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating, you are expected to uphold this code. Please report unacceptable behavior to

## Issues

Issues should be used to report bugs, request features, or discuss changes in existing features. When creating an issue, please follow the guidelines below:

- **Bug reports** should include a short summary of the bug, a description of the expected behavior, and a description of the actual behavior. If possible, please include a minimal code sample that reproduces the bug.
- **Feature requests** should include a short summary of the feature, a description of the motivation behind the feature, and a description of the proposed implementation.
- **Changes in existing features** should include a short summary of the change, a description of the motivation behind the change, and a description of the proposed implementation.
- **Questions** should include a short summary of the question, a description of the context in which the question arose, and a description of the desired outcome.
- **General discussions** should include a short summary of the topic, a description of the context in which the topic arose, and a description of the desired outcome.
- **Other issues** should include a short summary of the issue, a description of the context in which the issue arose, and a description of the desired outcome.
- **All issues** should be tagged with the appropriate labels. If you are unsure about which labels to use, please use the `help wanted` label.

## Pull Requests

Pull requests should be used to propose changes to the codebase. When creating a pull request, please follow the guidelines below:

- **Bug fixes** should include a short summary of the bug, a description of the expected behavior, and a description of the actual behavior. If possible, please include a minimal code sample that reproduces the bug.
- **New features** should include a short summary of the feature, a description of the motivation behind the feature, and a description of the proposed implementation.
- **Changes in existing features** should include a short summary of the change, a description of the motivation behind the change, and a description of the proposed implementation.
- **All pull requests** should be tagged with the appropriate labels. If you are unsure about which labels to use, please use the `help wanted` label.
- **All pull requests** should (but are not strictly required to) be accompanied by a description of the alternatives considered when making the changes in the pull request.

1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Nuno Pereira <nunoafonso2002@gmail.com>
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,9 @@ pytest /test

## Contributing

No contribution guidelines are available yet, but they will be soon.
Contribution guidelines can be found in [CONTRIBUTING](CONTRIBUTING.md)

Past and current contributors can be found in [CONTRIBUTORS](CONTRIBUTORS.md)

## License

Expand Down

0 comments on commit 86e0436

Please sign in to comment.