Add contributing information
Only the section with ways to get involved.
This commit is contained in:
parent
10019d7df9
commit
aa306d9050
21
CONTRIBUTING.md
Normal file
21
CONTRIBUTING.md
Normal file
@ -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)
|
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user