|
| 1 | +# Contributing guidelines to the Coding Dojo repo |
| 2 | + |
| 3 | +## Proposing a new Kata |
| 4 | +If you have any new kata's that you would like to share, you could do the following. |
| 5 | +1. Clone the repository; |
| 6 | +2. Create a new branch for your new Kata; |
| 7 | +3. Add the Kata to the folder `/katas/` (e.g. `/katas/my-new-kata/`). |
| 8 | +4. Open a Pull Request :) |
| 9 | + |
| 10 | +Once the Pull Request has been approved, you can find your katas in the repository. |
| 11 | + |
| 12 | +## Updating an Kata |
| 13 | + |
| 14 | +**DON'T** push to `master` directly. |
| 15 | + |
| 16 | +**DO**: |
| 17 | +1. Clone the repository; |
| 18 | +1. Create a branch from `master` and make your changes in it. |
| 19 | +2. Create a PR to master. |
| 20 | +3. Wait for review (you can go to the [Node Girls Slack](https://nodegirls-au.slack.com/) to announce your changes) |
| 21 | +4. If approved, your changes will be merged by the reviewer(s). |
| 22 | + |
| 23 | +## Pushing the work done during a session |
| 24 | + |
| 25 | +If you're organising a coding-dojo in your chapter, first of all, congratulations and thank you for teaching the best practices to others. We want to keep a clean repository. |
| 26 | + |
| 27 | +As an organiser, you'll have to share the work done during a session with all of the attendees. To do so, request access to the `coding-dojo` repo on the [Node Girls Slack](https://nodegirls-au.slack.com/) and then do the following |
| 28 | + |
| 29 | +**DON'T** push to `master` directly in a folder. |
| 30 | + |
| 31 | +**DO**: |
| 32 | +1. Create a branch from `master` following the branch naming convention. |
| 33 | +2. Push your changes on Github. |
| 34 | +3. Clean the `katas/` folder. Only keep the katas you've done during the session and delete the others |
| 35 | +3. Create a release tag with the same name as your branch. |
| 36 | +4. Share it with the attendants. |
| 37 | + |
| 38 | +### Branch naming convention |
| 39 | +The branch name has to contain your chapter's name and the coding-dojo date like so: `melbourne/28-03-2018`. If your coding dojo session has more than one group, suffix the name with a letter from A to Z : |
| 40 | +``` |
| 41 | +melbourne/28-03-2018_A |
| 42 | +melbourne/28-03-2018_B |
| 43 | +... |
| 44 | +``` |
0 commit comments