Skip to main content

Contribution

We are open for any contribution. The documentation is written in Markdown. And you can edit it in your favorite editor.

Docs contribution​

We welcome contributions to the documentation. We use the GitHub pages for the documentation. All documentation build from docs repo on GitHub. We use the mkdocs for the documentation.

Steps to contribute:​

  • Fork the docs repo
  • Clone the forked repo
  • Edit the docs into your favorite editor
  • Commit the changes
  • Push the changes to the forked repo
  • Open a pull request on the docs repo

Backend app contribution​

  • Clone the repo
  • Make your changes.
  • Add tests for your changes, if your changes are not tests.
  • Create a pull request. The all checks must pass for the pull request to be merged.
  • The app will be updated on production after the pull request is merged.