Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 3.15 KB
Raw

Contributing Guidelines

Firstly, thank you for contributing to this project. It means a lot to us. These guidelines are generally meant for contrributors who are new to open source. However, even if you are an experienced contributor to open source projects, you should still read these guidelines.

Before you get started, you must read our Code of Conduct and make sure you follow it. You also agree to our License and any changes you make will be licensed under those terms unless other terms have been specifically agreed upon beforehand.

Important

Do not report critical security flaws which can affect user security through GitHub. Instead, email us at [email protected] or personally contact one of the team members.

Found a bug? Let us know

  1. Firstly, go to the Issues page to see if the issue has not already been opened. You can use the search tool there to search for your issue. If you find a similar or related open issue, consider commenting on the issue if you are also facing the issue and/or have additional information which can help us debug and fix the issue.
  2. If you don't find a similar issue, consider opening a new issue. When you choose to create a new issue, you will have the option to use a template. Consider using the bug report template to report your issue.
  3. Follow the template and provide as much relevant information as you can. These include debug logs, your device details (such as phone model and version), app version etc. Include steps to reproduce the issue if possible.
  4. (optional) If the issue is really important, consider leaving a message on Gitter so that we can look into it faster.
  5. Make sure you give your issue a simple and descriptive title and then press Submit new issue to submit the issue.
  6. Follow the issue page for any updates or additional information we may ask you for. Consider adding relevant tags.

Want us to add a new feature? Open a request

  1. Similar to a bug report, go to the Issues page and search if there is already a similar request.
  2. Open a new Issue using the feature request template and provide as much details as you can.
  3. Follow the issue page for any updates!

Help us fix a bug or add a feature

  1. If there is an open issue, comment on the issue stating that you wish to work on the bug. If there isn't an open issue, you might want to open an issue and leave a comment to let us know you are working on the same.
  2. A moderator may assign the issue to you and update any project pages.
  3. Fork the repository in your own account and make changes there.
  4. Keep the issue page updated of the changes.
  5. Run all tests and make sure they pass.
  6. Open a Pull request to merge the changes into master. Provide relevant details and mention Fixes issue #(number) with the issue number that is being fixed. This ensures our automation tools automatically make changes in any project and close the issue when the PR is merged.