First off, thank you for considering contributing to this project. Whether you're interested in contributing code, or contributing in some other manner, we're happy to have you on board!
This document describes how to contribute the software aspects of our project, if you want to contribute by other means, please see our Onboarding Steps.
This project is moving very fast at the moment, both from development and organizational standpoints, and so it's very important you read this guide fully to reduce the additional work for our development and management teams.
Following these guidelines helps to communicate that you respect the time of the team leads managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests and other contributions.
Lots of people are working on this project at the same time, so we try our best to explicitly assign tasks to individuals to reduce the likelihood of duplicated or wasted effort.
Before we can assign any tasks to you, we ask that you read and complete the process detailed in our Onboarding Steps, and in particular Join a Team if possible.
Once you have done this, we will start being able to assign issues to you. You may take a look at the open issues, in particular, those labelled good first issue or help wanted.
We expect everyone to abide by our Code of Conduct. Please read it. 🤝
Here are a couple of friendly tutorials to help you get started: http://makeapullrequest.com/ and http://www.firsttimersonly.com/
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸
In this repo we favour yarn over npm as the "official" package manager since we also leverage yarn workspaces as the manager for our monorepo
Each Project has it's own required environment variables. Instructions for setting up Environment variables varies depending on the project and it's important that you look at the Contributing Guidelines for the Project before proceeding to contribute to the project.
The Guidelines for each project is detailed in the section below
Each project counts with it's own contributing guidelines, since they are different. So to read the specific guidelines for each project please refer to:
If you find a security vulnerability, please contact us directly at
security@reach4help.org. For any other non security-related issues, open an issue describing the problem.
Open an issue using with the suggestion you wish to give.
Your contribution will have to be Approved by a member of the Organization before being merged.
The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
We follow the conventional commits guidelines. Check here
Opening pull requests should be done with enough information and screenshots for visual changes to facilitate the reviewers job. Its MANDATORY to add a link to the issue related