Skip to content

Commit

Permalink
➕ add guide to contributing
Browse files Browse the repository at this point in the history
first draft

related #54
  • Loading branch information
des-des committed Jan 8, 2017
1 parent b6a52cc commit 4fb2e06
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Inspired by [dwys's contribution workflow](https://www.github.com/dwyl/contributing).

# Contribuation guidelines

## Before starting work

1. Search this repo's [issues](https://www.github.com/foundersandcoders/master-reference/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. Check the [readme](https://github.com/foundersandcoders/master-reference/blob/master/README.md) find someone to `@` 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](https://help.github.com/articles/associating-text-editors-with-git/#using-atom-as-your-editor).

The message should have the format

replace square braces
```md
short description under 50 chars.
[newline]
more detailed description (may be bullet points)
[newline]
related #[issue number]
```
or
```md
short description under 50 chars.
[newline]
related #[issue number]
```

It is important the 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.
3. An assignee, assign someone from [here](https://github.com/foundersandcoders/master-reference/blob/master/README.md

# Thankyou!

P.S. please star this repo.

0 comments on commit 4fb2e06

Please sign in to comment.