summaryrefslogtreecommitdiff
path: root/vendor/github.com/uptrace/bun/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/uptrace/bun/CONTRIBUTING.md')
-rw-r--r--vendor/github.com/uptrace/bun/CONTRIBUTING.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/github.com/uptrace/bun/CONTRIBUTING.md b/vendor/github.com/uptrace/bun/CONTRIBUTING.md
new file mode 100644
index 000000000..7c435b5ac
--- /dev/null
+++ b/vendor/github.com/uptrace/bun/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+## Running tests
+
+To run tests, you need Docker which starts PostgreSQL and MySQL servers:
+
+```shell
+cd internal/dbtest
+./test.sh
+```
+
+## Releasing
+
+1. Run `release.sh` script which updates versions in go.mod files and pushes a new branch to GitHub:
+
+```shell
+./scripts/release.sh -t v1.0.0
+```
+
+2. Open a pull request and wait for the build to finish.
+
+3. Merge the pull request and run `tag.sh` to create tags for packages:
+
+```shell
+./scripts/tag.sh -t v1.0.0
+```
+
+4. Push the tags:
+
+```shell
+git push origin --tags
+```