Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.55 KB

Contributing guidelines to the Coding Dojo repo

Proposing a new Kata

If you have any new kata's that you would like to share, you could do the following.

  1. Clone the repository;
  2. Create a new branch for your new Kata;
  3. Add the Kata to the folder /katas/ (e.g. /katas/my-new-kata/).
  4. Open a Pull Request :)

Once the Pull Request has been approved, you can find your katas in the repository.

Updating an Kata

DON'T push to master directly.

DO:

  1. Clone the repository;
  2. Create a branch from master and make your changes in it.
  3. Create a PR to master.
  4. Wait for review (you can go to the Muses Code JS Slack to announce your changes)
  5. If approved, your changes will be merged by the reviewer(s).

Pushing the work done during a session

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.

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 Muses Code JS Slack and then do the following

DON'T push to master directly in a folder.

DO:

  1. Create a branch from master following the branch naming convention.
  2. Push your changes on Github.
  3. Clean the katas/ folder. Only keep the katas you've done during the session and delete the others
  4. Create a release tag with the same name as your branch.
  5. Share it with the attendants.