Skip to content

Commit 40876a6

Browse files
committed
docs: add CONTRIBUTING.md for contributors
Document issue/PR expectations and local test workflow for new contributors.
1 parent 41dac16 commit 40876a6

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to sqlx
2+
3+
Thank you for your interest in contributing to sqlx.
4+
5+
## Before you open an issue or PR
6+
7+
- Search [existing issues](https://github.com/jmoiron/sqlx/issues) and [pull requests](https://github.com/jmoiron/sqlx/pulls) first.
8+
- For bugs, include a minimal Go program that reproduces the problem, your Go version, and database driver if relevant.
9+
- sqlx extends `database/sql`; confirm the behavior with plain `database/sql` when possible to isolate driver-specific issues.
10+
11+
## Pull requests
12+
13+
- Keep changes focused; avoid unrelated formatting or refactors.
14+
- Add or update tests for behavior changes (`go test ./...`).
15+
- Match existing code style in the files you touch.
16+
17+
## Development
18+
19+
```bash
20+
go test ./...
21+
```
22+
23+
Some tests require database drivers; run only package tests if you do not have databases configured locally.
24+
25+
## License
26+
27+
By contributing, you agree that your contributions are licensed under the same terms as the project (MIT).

0 commit comments

Comments
 (0)