Skip to content

Commit 8817c88

Browse files
authored
Create CONTRIBUTING.md
1 parent 25f5e73 commit 8817c88

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Hurray! We are glad that you want to contribute to our project! 🎊
2+
3+
Please follow standard github best practices: fork the repo, branch from master, make some commits, and submit a pull request.Please make sure to use gofmt before every commit - the easiest way to do this is have your editor run it for you upon saving a file.
4+
5+
# Getting Started
6+
If this is your first time contributing to a projects the following resources can help you get started
7+
- [This](https://www.youtube.com/watch?v=bgSDcTyysRc) is a video tutorial to get started contributing to a go project
8+
- [This](https://robots.thoughtbot.com/contributing-to-open-source-golang-projects) is similar textual version of the above tutorial
9+
- If you are new to github [this](https://github.com/firstcontributions/first-contributions/blob/master/README.md) is a good one to look up.
10+
11+
# Claiming an issue
12+
If you see an issue that you'd like to work on, please just post a comment saying that you want to work on it. Something like "I want to work on this" is fine.
13+
14+
# Dependencies
15+
We use [dep](https://golang.github.io/dep/) to manage dependencies.
16+
17+
https://opensource.guide/how-to-contribute
18+
 

0 commit comments

Comments
 (0)