Skip to content

Merging pull requests

yksflip edited this page Jun 13, 2025 · 9 revisions

Maintainership

Maintainers of the foodcoops/foodsoft repository are responsible for handling contributions. When a pull request is submitted, a maintainer reviews the changes (see Developing Guidelines).

At this time (2025-05-22) the following person have the maintainer role:

  • lentschi (flo)
  • ray
  • robwa
  • twothreenine (leo)
  • yksflip (philipp)

How to Pull-Request

  1. Open a new Pull-Request and reference the Issue it solves. Add a brief description about the changes and if in question any intentions of it.
  2. Make sure tests and rubocop are happy.
  3. UI changes should be localized in the i18n files directly.
  4. Add Screenshots if possible
  5. If you don't get any feedback after a week or so, send a ping to any of the maintainers.
  6. Small changes can also be fixed by the reviewer directly
  7. One approval is required for a PR to be merged
  8. If possible the person who opened the pull-request should also merge it.
  9. PR's that are stale (e.q. on activity for 6 months) will be closed after marking it with won't fix and a grace period of 4 weeks. It must be ensured there is an Issue linked to the PR.

Plugins

When merging a pull request for a plugin, there are some other things to check and do:

  • It needs its own LICENSE file, unless it is equal to foodsoft's (GPL3).
  • A plugin's locales go into its own config/locales/en.yml (see here). After merging:
  • Check that it is not enabled/included in the Gemfile, unless it's a default plugin (like the wiki).
  • There is no testing of plugins, yet. When in doubt, checkout and test locally with the plugin enabled.

Also see the Discussion for more background on this.

Clone this wiki locally