summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugen Wissner <belka@caraus.de>2017-06-19 09:13:02 +0200
committerEugen Wissner <belka@caraus.de>2017-06-19 09:13:02 +0200
commitaa306d905059b79d12553afb444c836173d28d3d (patch)
tree946c5dca45c787f2bf24f6b85d786096b180761d
parent10019d7df970168add624d0ebe8e78c60bafe318 (diff)
downloadtanya-aa306d905059b79d12553afb444c836173d28d3d.tar.gz
Add contributing information
Only the section with ways to get involved.
-rw-r--r--CONTRIBUTING.md21
-rw-r--r--README.md5
2 files changed, 22 insertions, 4 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)
diff --git a/README.md b/README.md
index 171e04b..edab246 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,7 @@ Tanya consists of the following packages:
* `async`: Event loop (epoll, kqueue and IOCP).
* `container`: Queue, Array, Singly and doubly linked lists, Buffers, UTF-8
string, Hash set.
+* `format`: Formatting and conversion functions.
* `math`: Arbitrary precision integer and a set of functions.
* `memory`: Tools for manual memory management (allocators, smart pointers).
* `network`: URL-Parsing, sockets, utilities.
@@ -63,7 +64,3 @@ is being tested on Windows and FreeBSD as well.
3-week release cycle.
Deprecated features are removed after one release (in approximately 6 weeks after deprecating).
-
-## Contributing
-
-Feel free to contact me if you have any questions: info@caraus.de.