We're glad to accept contributions from the community.
However, before you open a PR, please make sure there is a corresponding issue open. In the case of a new feature, a large refactoring, and similar non-trivial changes, it's necessary that a project maintainer greenlights it in advance on the issue page. Non pre-approved PRs that aren't bug fixes or trivial in nature will not be accepted.
Prerequisites:
- Familiarity with pull requests and issues.
- Knowledge of Markdown for editing
.mddocuments. - Knowledge of Kotlin
In particular, this community seeks the following types of contributions:
- Ideas: participate in an issue thread or start your own to have your voice heard.
- Bug fixes: bugs are inevitable, fixes are always welcome.
- Features: see the Contributions section above
We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
Please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.
Please be kind and courteous. There's no need to be mean or rude. Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer, merely an optimal answer given a set of values and circumstances. Try to assume that our community members are nice people and remember, miscommunication happens.
Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behaviour. We interpret the term "harassment" as including the definition in the Code of Conduct; if you have any lack of clarity about what might be included in that concept, please read the definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups.
Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the mantainers immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back.
Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
GitHub issues, PRs and discussions are the primary way for communicating about specific proposed changes to this project.
In all those contexts, please follow the conduct guidelines above. Language issues are often contentious and we'd like to keep discussion brief, civil and focused on what we're actually doing, not wandering off into too much imaginary stuff.
This guide is inspired to Juno Suárez' contribution guidelines, licensed under CC-0 license.