itwebtiger / khetha

📋 Khetha is an open-source tool created in partnership with Social Surveys Africa to engagement in the 2019 national election

📋 Khetha

Kheta is an open-source tool created in partnership with Social Surveys Africa to engagement in the 2019 national election

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 the following public Gitter channel.

🌱 1. Set up local environment

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

👓 2. Read our documentation

1. Please review the branches and commits sections in the following documentation.
2. Please read the following document outlining Khetha's code-architecture.
3. Run yarn start:docs to review component/module level documentation as needed.

❤️ 3. Contribute

1. Create a new branch in accordance with the above (skip this step if you are contributing on a specific branch)
2. If you are adding a new component/module make sure to follow the supplied new component/module instructions.
3. If you are modifying an existing component make sure to develop against yarn start:storybook to sandbox components from business logic.
4. Make sure to run yarn test as often as possible to catch any errors you introduced and confirm the scope of your changes.
5. If your changes broke any tests or any of the Storybook demos then make sure to include updated tests.

🚀 3. Make a pull request

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