aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644
index 0000000..00e7363
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,66 @@
+# 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
+
+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/).
+
+You do not need an account on SourceHut to contribute.
+
+## How to Contribute
+
+Bolt uses an [email-based workflow](https://git-send-email.io/) for
+accepting contributions.
+
+- Patches are submitted via email to the [bolt-devel mailing
+list](https://lists.sr.ht/~eugenetriguba/bolt-devel).
+- Discussions of new features can be proposed in [bolt-discuss
+mailing list](https://lists.sr.ht/~eugenetriguba/bolt-discuss)
+- Bug reports can be submitted to the [issue
+ tracker](https://todo.sr.ht/~eugenetriguba/bolt-issues)
+
+## Development Setup
+
+### Prerequisites
+
+- Go 1.23.0 or later
+- Docker (for running database integration tests)
+- git
+
+### Initial Setup
+
+1. Clone the repository:
+```bash
+git clone https://git.sr.ht/~eugenetriguba/bolt
+cd bolt
+```
+
+2. Install dependencies:
+```bash
+go mod download
+```
+
+3. Build the project:
+```bash
+go build -o bolt ./cmd/bolt
+```
+
+### Running Tests
+
+Bolt has integration tests for all supported databases. The test
+suite uses docker containers to run database instances.
+
+Run all tests:
+```bash
+./scripts/test.sh
+```
+
+Run tests for a specific database:
+```bash
+./scripts/test.sh postgres
+./scripts/test.sh mysql
+./scripts/test.sh mssql
+./scripts/test.sh sqlite3
+```