Skip to content

Commit f849454

Browse files
authoredMar 2, 2021
Create CONTRIBUTING.md
1 parent 142a3bb commit f849454

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed
 

‎CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Coding conventions
2+
Start reading our code. You'll get the hang of it. We optimize for readability:
3+
4+
- We indent using tabs
5+
- We use camel case for all function and variable names
6+
- We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]),
7+
around operators (x += 1, not x+=1), and around hash arrows.
8+
- This is open source software. Consider the people who will read your code, and make it
9+
look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when
10+
you're alone, but with passengers the goal is to make the ride as smooth as possible.
11+
- Formatting will be done with gofmt and all PRs must pass vetting and pipelines before
12+
being considered for a merge.
13+
14+
# Branches
15+
Let's try to keep a consistent branch naming scheme.
16+
17+
- **feature/your-name/whatever** for new feature proposals
18+
- **bug/your-name/whatever** for bug fixes
19+
- **release/X.X.X** is reserved for release branches

0 commit comments

Comments
 (0)