Thank you for considering to contribute to the Immuni documentation repository! In the following file you will find instructions and guidelines for contributing efficiently.
Before proceeding further, please review our Code of Conduct.
Issues
Pull Requests
Labels
Maintainers
⚠️ In order to have an effective contribution, please avoid any topic related to the Apple & Google protocol, since those would be considered out of scope for the current implementation
Browse the issue section and use the search functionality to look if the issue you encountered has already been filed.
- If this is the case, please avoid creating a new issue in order to avoid creating more entropy. Instead, you can add more info to such issue or, if the information are already present, you can insert the 👍 symbol in the first message. This will help the developers identify the relevant issues to be prioritized.
- If there is not a previous issue in the list, please proceed to create an issue.
Please consider to open an issue only if its content is relevant to this specific project.
When an issue is opened, a triage label is automatically assigned. As
such, the maintainers will be notified of the creation event and they will try to tackle it as soon as possible.
Therefore, when the issue has been triaged a corresponding label will be
assigned. Please see all the possible labels.
After opening an issue, you may want to further help the project. If the issue has been triaged and there is endorsement from the maintainers, you may want to propose a solution for such an issue. That's great and always appreciated! 😄
As such, the tool you need to use for this use case is the Pull Request one.
⚠️ Please ensure that there is a pertinent issue related to what you are proposing and also make sure that someone has already reviewed it before proceeding further⚠️
The first step you need to do in order to correctly open a Pull Request is to Fork the project. As such, first of all you need to have an account on the GitHub platform and be logged in. Then, you have to select the Fork button in the landing page of the repository. This will allow you to work on a dedicated fork, push your changes over there and then, if you want to contribute back to upstream, you can create a Pull Request targeting the master branch of this repository. For more extended information, please read this guide.
| Label name | Description |
|---|---|
| bug | Indicates an unexpected problem or unintended behavior |
| documentation | Indicates a need for improvements or additions to documentation |
| duplicate | Indicates similar issues or pull requests |
| enhancement | Indicates new feature requests |
| good first issue | Indicates a good issue for first-time contributors |
| help wanted | Indicates that a maintainer wants help on an issue or pull request |
| invalid | Indicates that an issue or pull request is no longer relevant |
| question | Indicates that an issue or pull request needs more information |
| wontfix | Indicates that work won't continue on an issue or pull request |
| triage | When the issue still needs to be triaged |
| backend | Issue dedicated to the backend side |
| frontend | Issue dedicated to the frontend side |
The following GitHub IDs currently have the maintainer role:
- @immuniopensource
- @immuniteam
- @immunistaff