Skip to content

Commit c4987aa

Browse files
committed
Add Contributing Guidelines
1 parent 12d794e commit c4987aa

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing Guidelines
2+
3+
## Reporting Issues
4+
5+
Please provide the following minimum information:
6+
* Your Go-MySQL-Driver version (or git SHA)
7+
* Your Go version (run `go version` in your console)
8+
* A detailed issue description
9+
* Error Log if present
10+
* If possible, a short example
11+
12+
13+
## Contributing Code
14+
15+
By contributing to this project, you share your code under the Mozilla Public License 2, as specified in the LICENSE file.
16+
Don't forget to add yourself to the AUTHORS file.
17+
18+
### Pull Requests Checklist
19+
20+
Please check the following points before submitting your pull request:
21+
- [x] Code compiles correctly
22+
- [x] Created tests, if possible
23+
- [x] All tests pass
24+
- [x] Extended the README / documentation, if necessary
25+
- [x] Added yourself to the AUTHORS file
26+
27+
### Code Review
28+
29+
Everyone is invited to review and comment on pull requests.
30+
If it looks fine to you, comment with "LGTM" (Looks good to me).
31+
32+
If changes are required, notice the reviewers with "PTAL" (Please take another look) after committing the fixes.
33+
34+
Before merging the Pull Request, at least one [team member](https://github.com/go-sql-driver?tab=members) must have commented with "LGTM".

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ To run the driver tests you may need to adjust the configuration. See the [Testi
290290
Go-MySQL-Driver is not feature-complete yet. Your help is very appreciated.
291291
If you want to contribute, you can work on an [open issue](https://github.com/go-sql-driver/mysql/issues?state=open) or review a [pull request](https://github.com/go-sql-driver/mysql/pulls).
292292

293-
Code changes must be proposed via a Pull Request and must be reviewed. Only *LGTM*-ed (" *Looks good to me* ") code may be committed to the master branch.
293+
See the [Contributing Guidelines](https://github.com/go-sql-driver/mysql/blob/master/CHANGELOG.md) for details.
294294

295295
---------------------------------------
296296

0 commit comments

Comments
 (0)