Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial contributor guide #1010

Merged
merged 3 commits into from
Mar 11, 2025
Merged

Initial contributor guide #1010

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fb6ca1
Initial contributor guide
dveeden Mar 10, 2025
8f20ce0
Merge branch 'master' into contrib
dveeden Mar 10, 2025
a8c8197
Update CONTRIBUTING.md
lance6716 Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# How to contribute

## Your first contribution

- Best to first create an issue and discuss the problem and possible solution.
- This isn't needed for small/obvious fixes.
- What is the context? e.g. what versions of go-mysql, MySQL, etc does this apply to?
- Do you have a simple test case? This can just be example code, it doesn't have to be a full test case.
- Why do you need this change?
- Format your code with [gofumpt](https://github.com/mvdan/gofumpt) if possible. (`make fmt` does this for you)
- Reference an issue in the PR if you have one.
- Update the `README.md` if applicable.
- Add tests where applicable.

## Asking for help

- Don't be afraid to ask for help in an issue or PR.
Loading