Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 4.81 KB

Contributing

PRs Welcome

OpenOlitor is a software tool that helps the management of Community Supported Agriculture (CSA) groups. This software it is made by people that follows the solidarity and transparency model of the CSAs. Your contributions help to change the food distribution system as well as making the community bigger and stronger.

This software was started and it is mainly maintained by Tegonal GmbH, available in https://github.com/tegonal.

Ways to contribute

First time contributor?

If you are looking for tasks where you could offer your help, please check the tasks that are labeled with help wanted However, those are not the only ways to help the project!. Here a more exhaustive list:

Submitting code

Note: We recommend you raise an issue on Github or send us an email to [email protected] about the change you would like to integrate before you start working on it. This will maximize the chances to integrate it to the final code and we can all learn from this process!!!

If you are looking for general technical information about the project you can go to the project wiki or other resources online like the presentation in FOSDEM 2020.

  1. Before you submit a pull request, please make sure your contribution passes all tests. Test failures need to be addressed before we can merge your contribution.
  2. Provide detail about the issue you are solving in the pull request description. Note: If your pull request addresses a specific issue, please reference it using openolitor/#
  3. Your PR will be reviewed by one of the repository's maintainers. Most PRs have at least one change requested before they're merged so don't be offended if your change doesn't get accepted on the first try!

Improving our documentation

The technical documentation of this project is published in the wiki. Is our documentation up to date? Have we covered everything we should? Could our wording be improved? then open a pull request with your suggested changes or additions. The user documentation is published in the OpenOlitor website. Please, contact us in case you would like to participate on the improuvement of the user documentation.

Improving-our-translations

The translations for the software are available in Crowdin, subscriber client, admin client and core client.

  1. If you would like to add a completely new language, please contact us to [email protected]. We will create the language in Crowdin for you;
  2. If you want to propose changes to the current translations, register yourself into Crowdin, and you would be ready to propose it!

If you would like to participate on the translation of the documentation, the 2 ways mentioned in the previous section are available:

  • in order to add translations to the technical documentation you could open a pull request with your translations.
  • in order to add translations to the user documentation, please contact us.

Use OpenOlitor for your CSA

If you want to use OpenOlitor in your CSA group, more specific information about it is published in openolitor.org. We encourage groups that are interested in this software to participate into the OpenOlitor International Group. In that case, please send a message throught the website form If you have questions about more specific features, check the list of videos available

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

This software was started and it is mainly maintained by Tegonal GmbH, available in https://github.com/tegonal.