diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c1028592 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +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: + +- Fork the repository on GitHub and clone (replace YOUR-USERNAME with your +GitHub username): + +``` +git clone https://github.com/YOUR-USERNAME/go +``` + +- 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 +``` + +- Work, commit often and write clear commit messages +- Push your changes to your fork of the repository: + +``` +git push +``` + +- Submit a Pull Request +- 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)