Skip to content

Commit f08d08d

Browse files
carvallegroticidesign
authored andcommitted
Added Contribution Guidelines. (#54)
1 parent 769510e commit f08d08d

File tree

2 files changed

+52
-15
lines changed

2 files changed

+52
-15
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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+
```

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,14 @@
3434
and you can find many more sources from global web!
3535

3636
### Running the Katas
37-
1. Clone the github repository
38-
2. Go to the katas that you want to work on
39-
note that the katas are grouped based on the session dates
40-
3. run `nvm use` to run with the latest node version
41-
4. run `npm install` to use the dependencies (at present its mocha to write the tests)
42-
5. run `npm test ` to run the tests
43-
44-
### Proposing a new Kata
45-
If you have any new kata's that you would like to share, you could do the following
46-
1. Clone the repository;
47-
2. Create a new branch for your new Kata;
48-
3. Add the Kata to the folder `/katas/` (e.g. `/katas/my-new-kata/`).
49-
4. Open a Pull Request :)
50-
51-
Once the Pull Request has been approved, you can find your katas in the repository.
5237

38+
1. Clone the github repository.
39+
2. run `nvm use` to run with the latest node version.
40+
3. run `npm install` to use the dependencies (at present its mocha to write the tests)
41+
4. run `npm test` to run the tests.
42+
43+
Share your work by following the [Contributing Guidelines](./CONTRIBUTING.md)
44+
45+
### Feedback
5346

5447
For any other feedbacks feel free to email us at `[email protected]`

0 commit comments

Comments
 (0)