From 3fb6ca18577a48924eef829a3130a67d92e6c015 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Mon, 10 Mar 2025 08:27:50 +0100 Subject: [PATCH 1/2] Initial contributor guide --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..76ce7d2f0 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. +- 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. From a8c8197c57fc1ca018b2bedbd5c72b9feadd1f0f Mon Sep 17 00:00:00 2001 From: lance6716 Date: Tue, 11 Mar 2025 10:17:47 +0800 Subject: [PATCH 2/2] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Daniël van Eeden --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76ce7d2f0..f56ca5b38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ - 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. +- 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.