From de99b6ff4e38b749ed69eae4d7d18e845a0e6fc5 Mon Sep 17 00:00:00 2001 From: Giacomo Marciani Date: Tue, 13 Aug 2024 16:13:15 +0200 Subject: [PATCH] [Docs] Add contributing guidelines. --- CONTRIBUTING.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0101249 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional +documentation, we greatly value feedback and contributions from our community. + +Please read through this document before submitting any issues or pull requests to ensure we have all the necessary +information to effectively respond to your bug report or contribution. + + +## Reporting Bugs or Feature Requests + +We welcome you to use the GitHub issue tracker to report bugs or suggest features. + +When filing an issue, please check [existing open issues](https://github.com/gmarciani/yawa/issues), +or [recently closed issues](https://github.com/gmarciani/yawa/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) +to make sure somebody else hasn't already reported the issue. +Please try to include as much information as you can. Details like these are incredibly useful: + +* A reproducible test case or series of steps +* The version of our code being used +* Any modifications you've made relevant to the bug +* Anything unusual about your environment or deployment + + +## Contributing via Pull Requests +Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: + +1. You are working against the latest source on the *mainline* branch. +2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. +3. You open an issue to discuss any significant work - we would hate for your time to be wasted. + +To send us a pull request, please: + +1. Fork the repository. +2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. +3. Ensure local tests pass. +4. Commit to your fork using clear commit messages. +5. Send us a pull request, answering any default questions in the pull request interface. +6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. + +GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and +[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). + + +## Finding contributions to work on +Looking at the existing issues is a great way to find something to contribute on. + + +## Code of Conduct +This project has adopted the code of conduct described [here](https://github.com/gmarciani/yawa/blob/mainline/CODE_OF_CONDUCT.md). + + +## Security issue notifications +If you discover a potential security issue in this project we ask that you notify us via our [vulnerability reporting page](https://github.com/gmarciani/yawa/security/advisories/new). +Please do **not** create a public github issue. + + +## Licensing +See the [LICENSE](https://github.com/gmarciani/yawa/blob/mainline/LICENSE) file for our project's licensing. +We will ask you to confirm the licensing of your contribution. + +We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.