|
|
@@ -0,0 +1,34 @@
|
|
|
+# Contributing Guidelines
|
|
|
+
|
|
|
+## Reporting Issues
|
|
|
+
|
|
|
+Please provide the following minimum information:
|
|
|
+* Your Go-MySQL-Driver version (or git SHA)
|
|
|
+* Your Go version (run `go version` in your console)
|
|
|
+* A detailed issue description
|
|
|
+* Error Log if present
|
|
|
+* If possible, a short example
|
|
|
+
|
|
|
+
|
|
|
+## Contributing Code
|
|
|
+
|
|
|
+By contributing to this project, you share your code under the Mozilla Public License 2, as specified in the LICENSE file.
|
|
|
+Don't forget to add yourself to the AUTHORS file.
|
|
|
+
|
|
|
+### Pull Requests Checklist
|
|
|
+
|
|
|
+Please check the following points before submitting your pull request:
|
|
|
+- [x] Code compiles correctly
|
|
|
+- [x] Created tests, if possible
|
|
|
+- [x] All tests pass
|
|
|
+- [x] Extended the README / documentation, if necessary
|
|
|
+- [x] Added yourself to the AUTHORS file
|
|
|
+
|
|
|
+### Code Review
|
|
|
+
|
|
|
+Everyone is invited to review and comment on pull requests.
|
|
|
+If it looks fine to you, comment with "LGTM" (Looks good to me).
|
|
|
+
|
|
|
+If changes are required, notice the reviewers with "PTAL" (Please take another look) after committing the fixes.
|
|
|
+
|
|
|
+Before merging the Pull Request, at least one [team member](https://github.com/go-sql-driver?tab=members) must have commented with "LGTM".
|