Skip to content

Commit 81ff5fd

Browse files
dveedenlance6716
andauthored
Initial contributor guide (#1010)
* Initial contributor guide * Update CONTRIBUTING.md Co-authored-by: Daniël van Eeden <[email protected]> --------- Co-authored-by: lance6716 <[email protected]>
1 parent f7fa260 commit 81ff5fd

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# How to contribute
2+
3+
## Your first contribution
4+
5+
- Best to first create an issue and discuss the problem and possible solution.
6+
- This isn't needed for small/obvious fixes.
7+
- What is the context? e.g. what versions of go-mysql, MySQL, etc does this apply to?
8+
- Do you have a simple test case? This can just be example code, it doesn't have to be a full test case.
9+
- Why do you need this change?
10+
- Format your code with [gofumpt](https://github.com/mvdan/gofumpt) if possible. (`make fmt` does this for you)
11+
- Reference an issue in the PR if you have one.
12+
- Update the `README.md` if applicable.
13+
- Add tests where applicable.
14+
15+
## Asking for help
16+
17+
- Don't be afraid to ask for help in an issue or PR.

0 commit comments

Comments
 (0)