From 8adf4207b7c88b706bd4235db164bd8634a77f83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dutrieux?= Date: Wed, 26 Jun 2024 18:50:48 +0200 Subject: [PATCH] Add contributing guidelines --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7910b83 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to nrt + +Thanks for taking the time to contribute to nrt! 🎉 + +## Rights + +The EUPL v2 license (see LICENSE) applies to all contributions. + +## How Can I Contribute? + +### Reporting Bugs + +If you find a bug, please open an issue and include as much detail as possible. Include steps to reproduce the issue and any relevant logs or screenshots. + +### Suggesting Enhancements + +Enhancement suggestions are welcome! If you have an idea to improve nrt or its documentation, please open an issue and describe your idea in detail. If possible, provide examples of how the enhancement would be used. + +### Code Contributions + +For any contribution to the code base or the documentation, use the pull request mechanism. +1. Fork the repository: Click the 'Fork' button on the upper right corner of the repository page. +2. Apply changes to your fork. +3. Open a pull request on github + +Your contribution will be reviewed and discussied as part of the pull request. If approved, it will then be merged +into the main branch of the repository and included in the following release. + + +