Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.72 KB
Raw

Contributing

  • File an issue to report a bug or feature request
  • Translate the project in our Crowdin project
  • Make the Pull Request to contribute

Bug Report

File an issue about the bug or feature request. Make sure you are installing the latest version of the app from TestFlight or App Store.

Translation

Crowdin

The translation will update regularly. Please request the language if it is not listed via an issue.

Pull Request

You can create a pull request directly with small block code changes for bugfix or feature implementations. Before making a pull request with hundred lines of changes to this repository, please first discuss the change you wish to make via an issue.

Also, there are lots of existing feature request issues that could be a good-first-issue discussing place.

Follow the git-flow pattern to make your pull request.

  1. Ensure you have started a new branch based on the develop branch.
  2. Write your changes and test them on iPad and iPhone.
  3. Merge the develop branch into your branch then make a Pull Request. Please merge the branch and resolve any conflicts if develop updates. Do not force push your commits.
  4. Make sure the permission for your fork is open to the reviewer. Code style fix, conflict resolution, and other changes may be committed by the reviewer directly.
  5. Request a code review and wait for approval. The PR will be merged when it is approved.

Documentation

The documentation for this app is listed under the Documentation folder. We are also welcoming contributions for documentation.