We really appreciate that you are considering contributing! There are many ways you can help us to improve the course material. The preferred way is to make a pull request, but you can also submit an issue, help with translations or review existing pull requests, for example.
- Fork the repository
- Clone your fork
- Verify that you are running Node version 10 (NVM recommended for managing node versions)
- Install dependencies with
npm install - Start the application with
npm start - Application will be available at http://localhost:8000
- Prettify your code with
npm run format - Create a new branch for your changes
- Create the PR from that branch to the source branch
- If your pull request is for a specific part of the course material, please add a corresponding label to your pull request (eg. "Part 3")
When translation of a whole new part is completed, remember to update the file src/utils/translationProgress.json This file tracks the progress of translations, ranging from 0 (part0) to 13 (part13). It is used in the to avoid navigation errors when the user tries to access untranslated parts of the course. At the same time, it is used to automatically redirect the user to the English material (until the part is translated). So, if you have been working on a translation, remember to update this file after completing the translation of a whole part.