49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
# Contributing Guidelines
|
|
|
|
This document contains information and guidelines about contributing to this project.
|
|
Please read it before you start participating.
|
|
|
|
**Topics**
|
|
|
|
* [Asking Questions](#asking-questions)
|
|
* [Reporting Security Issues](#reporting-security-issues)
|
|
* [Reporting Non Security Issues](#reporting-other-issues)
|
|
|
|
## Asking Questions
|
|
|
|
Questions are welcome! We encourage you to ask questions through GitHub issues.
|
|
Before doing so, please check that the project issues database doesn't already
|
|
include an answer to your question. Then open a new Issue and use the "Question"
|
|
label.
|
|
|
|
## Reporting Security Issues
|
|
|
|
If you have discovered an issue with this code that could present a security hazard or wish to discuss a sensitive issue with our security team, please contact us on [Telegram](https://hush.is/tg) or [Matrix](https://hush.is/matrix)
|
|
|
|
## Reporting Non Security Issues
|
|
|
|
A great way to contribute to the project
|
|
is to send a detailed issue when you encounter a problem.
|
|
We always appreciate a well-written, thorough bug report.
|
|
|
|
Check that the project issues database
|
|
doesn't already include that problem or suggestion before submitting an issue.
|
|
|
|
|
|
When reporting issues, please include the following:
|
|
|
|
* The Android API you're using
|
|
* The device you're targeting
|
|
* The full output of any stack trace or compiler error
|
|
* A code snippet that reproduces the described behavior, if applicable
|
|
* Any other details that would be useful in understanding the problem
|
|
|
|
This information will help us review and fix your issue faster.
|
|
|
|
## Code contributions
|
|
|
|
We love contributions.
|
|
|
|
All contributions _will_ be licensed under the GPLv3 license.
|
|
|