Notes to contributors

[andrealaw]

General guidelines on how to contribute

Pick an issue

1. Find an item that you can contribute to and pick it up by leaving your name under the issue so others will know that someone has picked up the task.
2. Request for a new branch if that is not available (optional).
3. Submit a pull request and ask for a review.
4. Once the code changes get reviewed and tested, they will be merged to the respective branch for production.
5. Your pull request is successful and you will have this contribution shown in your Github account.

Add a new issue

If you want to add a new issue or discuss about a particular change for the website, like building a new template, adding a new section, or migrating to a new platform, please add a new issue and assign a relevant label to it.

Review, merge and delete merged branches

1. Contact the administration team if you can be a reviewer.
2. Reviewers should test the code changes before merging to the respective branch.
3. Leave your comment if further changes are required for the pull request.
4. Before pressing the merge button, check the commit message. If you want to close an issue at the same time, follow this pattern to ensure keywords(e.g., close or resolve) are used and an issue number is added (e.g., Link doesn't work #9) for tracking.
5. Delete the branch according to the Github instructions.

About the administrators

This repository is currently maintained by a team of volunteers from Free Code Camp Hong Kong. You can find a list of members here: @FreeCodeCampHongKong/admin

Thanks!

[anglyeds]

Thank for the notes, I just noticed there are few codes that I have to review.

[gregorywong]

@anglyeds So actually, Isaac has added a new plugin which allows the pull requests to be previewed, meaning that you don't have to fetch the code and open it locally. You can just click the green check mark next to the commit hash to get a preview.

See this comment for more information: #21 (comment)

[gregorywong]

@anglyeds Clarification: It's better to click on "Details" to see the latest commit:

[gregorywong]

Should I follow this guide and consolidate our contributor's guidelines in one place according to this guide?

https://help.github.com/articles/setting-guidelines-for-repository-contributors/