- Search tickets before you file a new one. Add to tickets if you have new information about the issue.
- Keep tickets short but sweet. Make sure you include all the context needed to solve the issue. Don't overdo it. Great tickets allow us to focus on solving problems instead of discussing them.
- Take care of your ticket. When you spend time to report a ticket with care we'll enjoy fixing it for you.
- Use GitHub-flavored Markdown. Especially put code blocks and console outputs in backticks (
```). That increases the readability. Bonus points for applying the appropriate syntax highlighting.
In short, since you are most likely a developer, provide a ticket that you yourself would like to receive.
First check if you are using the latest library version and Kotlin version before filing a ticket.
Please include steps to reproduce and all other relevant information, including any other relevant dependency and version information.
Please try to be precise about the proposed outcome of the feature and how it would related to existing features.
We love pull requests!
All contributions will be licensed under the Apache 2 license.
Code/comments should adhere to the following rules:
- Names should be descriptive and concise.
- Use four spaces and no tabs.
- Remember that source code usually gets written once and read often: ensure the reader doesn't have to make guesses. Make sure that the purpose and inner logic are either obvious to a reasonably skilled professional, or add a comment that explains it.
- Please add a detailed description.
If you consistently contribute improvements and/or bug fixes, we're happy to make you a maintainer.