Your contribution is more than welcome!
For better project maintenance, please read this guide before creating issues and pull requests.
This repository is currently maintained by a team of volunteers from freeCodeCamp Hong Kong @FreeCodeCampHongKong/admin. Feel free to contact us if you encounter any problems with / have any suggestions for this repository.
If you want to add a new issue or propose a particular change for the website (e.g. building a new template, adding a new section, or migrating to a new platform), add a new issue and assign a relevant label to it.
- Pick an issue that you can contribute to by assigning yourself the task, so others will know that you have picked up the task. If you are unable to do so, leave your name under the issue and someone will send you an invitation link to the org. Assign yourself after accepting the invitation.
- Start a new branch for the issue if it hasn't been created already. Alternatively, you can fork the repo and work within the forked repo as well.
- Once you have committed code in the new branch, submit a pull request and ask for a review.
- Once the code changes get reviewed and tested, they will be merged to the respective branch for production.
- If your pull request is successful, your contribution will be shown in your Github account.
- Contact the administration team if you can be a reviewer.
- Reviewers can preview the changes by using netlify. Simply click on "Details" to see a preview of the deployed page. If unsure, always test the code changes locally before merging to the respective branch.
- Leave reviews if further changes are required for the pull request.
- Before pressing the merge button, edit the commit message to ensure present tense is used and an issue number is added (e.g. #9) for tracking. You can also close issues using keywords if you reference the issue in your pull request description or commit message. (e.g. "close #1", "fix #1", "resolve #1", etc).
- Delete the branch according to the GitHub instructions.