diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e2435e92 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +![](https://github.com/Valerioageno/tuono/actions/workflows/rust.yml/badge.svg) +![](https://github.com/Valerioageno/tuono/actions/workflows/typescript.yml/badge.svg) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +# How to contribute to Tuono + +## Contributions +Any feature contribution and suggestions is strongly appreciated. +Since the current project size there isn't yet a defined way to start a discussion. Consider to [open a new issue](https://github.com/Valerioageno/tuono/issues/new) +or to reach me using my email address [valerioageno@yahoo.it](mailto:valerioageno@ahoo.it). I'm also available on twitter (X) DMs @valerioageno. + +## Bugs + +**Did you find a bug?** +- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/Valerioageno/tuono/issues). +- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Valerioageno/tuono/issues/new). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. + +**Did you write a patch that fixes a bug?** +- Open a new GitHub pull request with the patch. +- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. +- The pull requests must pass all the CI pipelines