diff options
| author | Eugen Wissner <belka@caraus.de> | 2017-06-19 09:13:02 +0200 |
|---|---|---|
| committer | Eugen Wissner <belka@caraus.de> | 2017-06-19 09:13:02 +0200 |
| commit | aa306d905059b79d12553afb444c836173d28d3d (patch) | |
| tree | 946c5dca45c787f2bf24f6b85d786096b180761d /CONTRIBUTING.md | |
| parent | 10019d7df970168add624d0ebe8e78c60bafe318 (diff) | |
| download | tanya-aa306d905059b79d12553afb444c836173d28d3d.tar.gz | |
Add contributing information
Only the section with ways to get involved.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0ae9af0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +Tanya is a project in active development, therefore any help is appreciated. Thank you for considering contributing +to it, feel welcome. +These guidelines describe ways to get started. + +## Ways to get involved + +* **Reporting a problem**: [https://issues.caraus.io/projects/tanya/issues](Report) bugs and usage problems you +encounter. +* **Fixing issues**: [https://issues.caraus.io/projects/tanya/issues](The bug tracker) contains a list of issues you +can work on. +* **Documentation**: You can improve API documentation by correcting grammar errors, completing existing texts and +writing new ones, or providing usage examples. +* **Testing**: Test coverage is important for a library. Writing tests is not only helpful, but is also a great way +to get a feel for how tanya works. + +## Questions and suggestions + +* [Open an issue](https://issues.caraus.io/projects/tanya/issues) +* [Send an email](mailto:info@caraus.de) |