Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 2.5 KB

moderators.md

File metadata and controls

27 lines (14 loc) · 2.5 KB
Raw

Moderator doc

THANKS for volunteering to manage [our Blog Code Challenge Pull Requests](open PR counter).

Here is a quick HOWTO:

  1. Ping pybob or clamytoe on our Slack to be added as collaborator to this repo.

  2. While on Slack please join our #pull-requests channel: new PRs get posted there and we use it to discuss issues and/or clarify doubts.

  3. When you merge a PR there are a few things to verify:

  • does the user have the community branch as destination? We want to keep master pristine, so make sure we're merging into community. As a moderator you can change it on the PR.

  • we only accept ONE PR FOR ONE CHALLENGE, so if the user opens a PR for multiple challenges (easy to spot by looking at the numbered directories), they did not follow our platform's procedure so kindly point them to it.

  • user should not overwrite any template files or pre-delivered tests. If this cannot be fixed on the branch, just deny/close the PR without merging.

  • user should have committed the files in a "PCC number / username" directory to keep their code in the right place and isolated from other submissions, e.g. 62/bbelderbos if I would PR my submission for PCC62 *1

  • user commits big text files (e.g. PCC01 dictionary.txt - might be our bad not telling them), just delete this file from the submission if possible.

  • ideally (but optionally) review the code providing some feedback what is awesome and what could be coded better, people love it and we assume this is the exciting part for you guys ("to be a mentor" is one of the most satisfying things, no?). Look at previous PRs to see examples. If we have a high load, merging trumps review ;)

  • merge the PR into the community branch (if you wonder why not solutions, that's legacy, for blog challenges we want community contributions, not one 'right' answer, hence we created a better named branch). Another notification will be posted to the Slack channel and the open PR counter will go down, you're awesome! There is also a platform job that syncs PRs back from GH to platform so they show up as completed there.

*1 we often refer to our Blog Code Challenge as PCC, PCC stands for PyBites Code Challenge (not to confuse with our Bites of Py Exercises)