From 4fb2e060f6e078c7f735d954cad1ff15c349e6c1 Mon Sep 17 00:00:00 2001 From: eoin-mc-carthy Date: Sun, 8 Jan 2017 14:51:40 +0000 Subject: [PATCH 1/2] :heavy_plus_sign: add guide to contributing first draft related #54 --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a2147d05 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. From ada16c257d54df34bf168a37b41d18c72dac6e2f Mon Sep 17 00:00:00 2001 From: eoin-mc-carthy Date: Sun, 8 Jan 2017 17:25:11 +0000 Subject: [PATCH 2/2] :registered: fix typos related #54 --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2147d05..91d8b63a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ Inspired by [dwys's contribution workflow](https://www.github.com/dwyl/contributing). -# Contribuation guidelines +# Contribution 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. + 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) and 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 @@ -33,7 +33,7 @@ short description under 50 chars. related #[issue number] ``` -It is important the you reference an issue in each commit. +It is important that you reference an issue in each commit. ## Pull Requests @@ -42,8 +42,8 @@ Once you have finished your work, push up your branch and make a pull request. M 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 + 4. An assignee, assign someone from [here](https://github.com/foundersandcoders/master-reference/blob/master/README.md) -# Thankyou! +# Thank you! P.S. please star this repo.