IMPORTANT: Everything that needs to be filled in is marked with !!!, find all instances of !!! to replace with live content.

IMPORTANT: Make sure that Travis and Netlify is set up and using !!!GITHUB_PROJECT_NAME before you complete this file.

!!!OPTIONAL_EMOJI !!!PROJECT_NAME

!!PROJECT_ONE_LINE_DESCRIPTION

Contributor instructions:

If you have any questions about the following instructions please get in touch with us via our core-team Slack workspace (if you have access) or send an email to schalk@openup.org.za.

Clone the repository by running git clone https://github.com/OpenUpSA/!!!GITHUB_PROJECT_NAME.git.
Make sure you have the latest release of NodeJS installed.
Make sure you have the latest release of Yarn installed.
Run yarn in the root folder of the repository to install all dependancies.

Please familiarise yourself with this project's architecture and guidelines before proceding.

If you are making a public pull request (i.e. you do not have write access) use the forking Git workflow.
If you are a project contributor (.e. you have write access) use the feature branch Git workflow.
Make a pull request via the Github dashboard to the master branch.
The designated owner of the repository will automatically be tagged in all pull requests via the docs/CODEOWNERS file.
Once your code has been accepted and merged into master Netlify will automatically deploy the changes to khetha.org.za.