Contribute

  1. Bug reports
  2. Translations
  3. Code
  4. Documentation

Thank you for considering contributing to Gancio!

You can contribute in the following ways:

  • Finding and reporting bugs (please use the confidential flag for security related issues)
  • Translating the plugin into various languages
  • Contributing code by fixing bugs or implementing features
  • Improving the documentation
  • Proposing ideas for new features

Bug reports

Bug reports and feature suggestions must use descriptive and concise titles and be submitted to Framagit Issues.

To solve your problem we need to be able to reproduce it, be very specific and add as much details as possible, at least: version used, installation mode (docker, debian, yunohost, other?), db used (sqlite, mariadb, postgresql) and any other relevant information such as, screenshots, logs, urls, description of operations to reproduce the problem, etc.

Please use the search function to make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected.

Translations

You can submit translations via weblate.org. Note that if you want to change some label for your own instance you can do it.

Code

Building software means taking a stand, making decisions, choices. These choices start from a precise look at reality, from specific needs and ends implementing specific features, choose default values, simplify some flow and patterns while making difficult others.

To help with issues you can check for Contibution welcome, good first issue or help needed tags.

Please use clean, concise titles for your pull requests. Unless the pull request is about refactoring code or other internal tasks, assume that the person reading the pull request title is not a programmer but an user and try to describe your change or fix from their perspective. We use commit squashing, so the final commit in the main branch will carry the title of the pull request, and commits from the main branch are fed into the changelog. Please use conventional commits in your commit messages.

The smaller the set of changes in the pull request is, the quicker it can be reviewed and merged. Splitting tasks into multiple smaller pull requests is often preferable.

Documentation

As you can see there is a big space for improvements here :smile: