Add contributing guideline

tomohiro · Oct 17, 2015 · 1b99208 · 1b99208
1 parent a2a9909
commit 1b99208
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+Contributing
+--------------------------------------------------------------------------------
+
+1. Fork it ( https://github.com/Tomohiro/go-gyazo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run `goimports` or `gofmt -s` to format your codes.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+Thanks! :heart: :heart: :heart:
diff --git a/README.md b/README.md
@@ -51,6 +51,11 @@ fmt.Println(image.PermalinkURL) // http://gyazo.com/8980c52421e452ac3355ca3e5cfe
 result, _ := gyazo.Delete("8980c52421e452ac3355ca3e5cfe7a0c")
 ```
 
+Contributing
+--------------------------------------------------------------------------------
+
+Please check out the [CONTIRBUTING](CONTRIBUTING.md) guideline.
+
 
 LICENSE
 --------------------------------------------------------------------------------