Contributing

We love improvements to our tools! There are a few key ways you can help us improve our projects:

Submitting Feedback, Requests, and Bugs

Our process for submitting feedback, feature requests, and reporting bugs usually begins by discussion on our chat and, after initial clarification, through GitHub issues. Each project repository generally maintains its own set of issues:

    https://github.com/openzim/<repository-name>/issues

Some projects have additional templates or sets of questions for each issue, which you will be prompted to fill out when creating one.

Issues that span multiple projects or are about coordinating how we work overall are in the Overview Issue Tracker.

To know how to label an issue, have a look to https://help.github.com/articles/about-labels/.

Submitting Code and Documentation Changes

We already have important guidelines.

Our process for accepting changes operates by Pull Request (PR) and has a few steps:

1. If you haven't submitted anything before, and you aren't (yet!) a member of our organization, fork and clone the repo:

   $ git clone git@github.com:<your-username>/<repository-name>.git
   

   Organization members should clone the upsteam repo, instead of working from a personal fork:

   $ git clone git@github.com:openzim/<repository-name>.git
   

2. Once you are ready to develop an improvement, follow the instructions given.

Welcome on board and thank you in advance for your first contribution!