Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (36 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 1.94 KB

Inspired by dwyl's contribution workflow.

The following people are available to review pull requests: @bradreeder, @des-des, @sofer, @iteles or @nelsonic.

Contribution guidelines

Before starting work

  1. Search this repo's issues to see if an issue exists for the problem you are solving
  2. If the issue does not exist, create it.
  3. Indicate on the issue that you would like to take it on. Ping one of the reviewer above if you need a response.
  4. Once you are sure of what you need to do and that it is needed, assign yourself to the issue.
  5. Clone, and create a new branch for your work

Multiline commit messages

You will want to space your commit messages over more than one line. Commit without the -m to bring up a text editor in which to write the commit message.

You may want to configure git to use your preferred text editor, if you do not like the default. ie. Set atom to be default commit message editor.

The message should have the format

replace square braces

short description under 50 chars.
[newline]
more detailed description (may be bullet points)
[newline]
related #[issue number]

or

short description under 50 chars.
[newline]
related #[issue number]

It is important that you reference an issue in each commit.

Pull Requests

Once you have finished your work, push up your branch and make a pull request. Make sure it has the following

  1. A good title
  2. Description, with detail of everything in the pull.
  3. Reference to the issue in description.
  4. An assignee, assign someone from the list at the top.

Thank you!

P.S. please star this repo.