From 1ce745205e03354ecd16ab02dbecb49ecff7d9e3 Mon Sep 17 00:00:00 2001 From: wuyangfan <1102042793@qq.com> Date: Sun, 17 May 2026 19:46:55 +0800 Subject: [PATCH] docs: add CONTRIBUTING.md for contributors Document issue/PR expectations and local test workflow for new contributors. Co-authored-by: Cursor --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..1dc125424 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to sqlx + +Thank you for your interest in contributing to sqlx. + +## Before you open an issue or PR + +- Search [existing issues](https://github.com/jmoiron/sqlx/issues) and [pull requests](https://github.com/jmoiron/sqlx/pulls) first. +- For bugs, include a minimal Go program that reproduces the problem, your Go version, and database driver if relevant. +- sqlx extends `database/sql`; confirm the behavior with plain `database/sql` when possible to isolate driver-specific issues. + +## Pull requests + +- Keep changes focused; avoid unrelated formatting or refactors. +- Add or update tests for behavior changes (`go test ./...`). +- Match existing code style in the files you touch. + +## Development + +```bash +go test ./... +``` + +Some tests require database drivers; run only package tests if you do not have databases configured locally. + +## License + +By contributing, you agree that your contributions are licensed under the same terms as the project (MIT).