aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-10-18 10:43:39 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-11-26 11:46:57 -0500
commite5658d1f61415054029b66cd2f703f1f40138460 (patch)
treec609e209f4cebc62dd985d1b773558f47eb73bf6 /docs/contributing.md
parentAdd is-branch main check for docs deployment (diff)
downloadcli-e5658d1f61415054029b66cd2f703f1f40138460.zip
Add support for migration dependencies
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md33
1 files changed, 19 insertions, 14 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 109b04a..418958f 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -1,8 +1,7 @@
# Contributing to Bolt
-Thank you for your interest in contributing to Bolt! This document provides guidelines and instructions for contributing to the project.
-
-## Getting Started
+Thank you for your interest in contributing to Bolt! This document provides
+guidelines and instructions for contributing to the project.
Bolt is hosted on [SourceHut](https://sr.ht/~eugenetriguba/Bolt/). If you're new
to SourceHut, see the [git.sr.ht quickstart](https://man.sr.ht/git.sr.ht/).
@@ -14,22 +13,16 @@ You do not need an account on SourceHut to contribute.
Bolt uses an [email-based workflow](https://git-send-email.io/) for
accepting contributions.
-- Patches should be submitted via email to my [public-inbox mailing
-list](https://lists.sr.ht/~eugenetriguba/public-inbox) with the subject
-prefix `[PATCH bolt]`.
-- General questions and discussions about the bolt project can be sent to my
-[public-inbox mailing list](https://lists.sr.ht/~eugenetriguba/public-inbox).
-- Bug reports can be submitted to my [public-inbox mailing
-list](https://lists.sr.ht/~eugenetriguba/public-inbox).
-
-For general questions, discussions, or bug reports, please make it obvious in
-the subject line it is for the bolt project.
+- All questions, discussions, requests, or patches should be submitted via
+ email to my [public-inbox mailing list](https://lists.sr.ht/~eugenetriguba/public-inbox).
+ For patches, use the subject prefix `[PATCH bolt]`. For anything else, please
+ make it obvious it is for the bolt project.
## Development Setup
### Prerequisites
-- Go 1.23.0 or later
+- Go 1.24.0 or later
- Docker (for running database integration tests)
- git
@@ -73,3 +66,15 @@ Run tests for a specific database:
./scripts/test.sh mssql
./scripts/test.sh sqlite3
```
+
+### Running Linters/Formatters
+
+To lint:
+```bash
+./scripts/lint.sh
+```
+
+To format:
+```bash
+./scripts/format.sh
+```