Commit Africa Front-end

Discussion

Have any question or suggestions, please reach out to the core team on Gitter at commit-africa/community.

Alternatively, if you want to get involved in the larger discussion around usage of technology for social good in Africa join us on Slack (on either the Code for Africa or ZA Tech workspaces) in the #tech-for-good channel.

Licensing

• The following licensing only applies to the content inside this repo itself and is not inherited by any projects/repositories linked to from this repo.
• All code is licensed under the MIT license.
• All non-code content is licensed under Creative Commons BB-SA 4.0

Contributor instructions:

🌱 1. Set up local environment

1. Clone the repository by running git clone https://github.com/commit-africa/commit.africa.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 the architecture and conventions used in the Commit Africa front-end.

❤️ 3. Contribute

1. Create a new branch in accordance with the above (skip this step if you are contributing on a specific branch)
2. Make sure to integrate ESLint for your specific IDE (see guide) to get real-time linting errors in TypeScript.
3. Make sure to integrate Stylelint (see guide) for your IDE to get real-time linting errors in Styled Components.
4. If you are making changes to internal logic please run yarn test as often as possible to catch any errors you introduced and confirm the scope of your changes.
5. If you are adding a new React component please see .blueprints/component for convetion used. If you are using Visual Studio Code you can automate the creation of new components via the Blueprint extension.
6. If you are adding an entry (in the packages/webapp/src/data) please use the following format:

---
name: Project name
region: Western Cape
country: South Africa
core-team: 3
---

This is a blurb explaining what this project is about and what types of contributions the team is looking for.

🚀 3. Make a pull request

1. If you are making a public pull request use the forking Git workflow.
2. If you are a core contributor (i.e. you have write access) please use the feature branch Git workflow.
3. Make a pull request via the Github dashboard to the master or feature branch.
4. The responsible core-contributor (as per the repo) 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 https://commit.africa.

Roadmap

0.0.2

• Adds https//commit.africa/submit page
  • Integrate with Netlify Forms.
  • Integrate with Territories to create predictable/filterable geographic meta data for projects.
  • Create submission page UI.
• Adds https//commit.africa/browse page.
  • Determine required steps.