From d95b350435c8b98cbc5d2807b3ea00a5b9fce800 Mon Sep 17 00:00:00 2001 From: Ryan Weir Date: Wed, 3 Aug 2016 21:40:02 -0400 Subject: [PATCH 1/2] Add CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ README.md | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a13b8c2a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# How to Contribute +This is an Open Source effort and contributions are welcome to keep the Project +alive and current! To make things easy, please use the following guidelines for +making contributions: +1. Fork the repository on GitHub and clone (replace YOUR-USERNAME with your +GitHub username): +``` +git clone https://github.com/YOUR-USERNAME/go +``` +2. cd into the directory and create a topic branch from master (replace +MY-CONTRIBUTION with an appropriate title): +``` +cd go +git checkout -b MY-CONTRIBUTION master +``` +3. Work, commit often and write clear commit messages +4. Push your changes to your fork of the repository: +``` +git push +``` +5. Submit a Pull Request +6. Repeat (i.e., make another contribution) diff --git a/README.md b/README.md index 544d8ff5..25d84130 100644 --- a/README.md +++ b/README.md @@ -262,6 +262,6 @@ Non-Open-Source books, courses, and resources are noted with ```$```. ## Contribute -Please Contribute -- **this is Open Source!** +See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines! [Follow me on Twitter @clarecorthell](http://bit.ly/clarecorthelltwitter) From 61c45de5f43ef6455b29aca9021373bc057f4789 Mon Sep 17 00:00:00 2001 From: Ryan Weir Date: Wed, 3 Aug 2016 21:45:21 -0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a13b8c2a..c1028592 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,26 @@ # How to Contribute -This is an Open Source effort and contributions are welcome to keep the Project -alive and current! To make things easy, please use the following guidelines for -making contributions: -1. Fork the repository on GitHub and clone (replace YOUR-USERNAME with your +This is an Open Source effort and contributions are welcome to keep the Project alive and current! To make things easy, please use the following guidelines for making contributions: + +- Fork the repository on GitHub and clone (replace YOUR-USERNAME with your GitHub username): + ``` git clone https://github.com/YOUR-USERNAME/go ``` -2. cd into the directory and create a topic branch from master (replace -MY-CONTRIBUTION with an appropriate title): + +- cd into the directory and create a topic branch from master (replace MY-CONTRIBUTION with an appropriate title): + ``` cd go git checkout -b MY-CONTRIBUTION master ``` -3. Work, commit often and write clear commit messages -4. Push your changes to your fork of the repository: + +- Work, commit often and write clear commit messages +- Push your changes to your fork of the repository: + ``` git push ``` -5. Submit a Pull Request -6. Repeat (i.e., make another contribution) + +- Submit a Pull Request +- Repeat (i.e., make another contribution)