aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2026-02-12 19:14:17 -0500
committerEugene Triguba <hello@eugenetriguba.com>2026-02-12 19:14:17 -0500
commit449f74ded67b49fb3066d6d107fa6de9dba0093c (patch)
treed18017e8e318541781d5cf1cb3e161d3c2ee0be8 /docs/contributing.md
parentRelease v0.12.1 (diff)
downloadcli-449f74ded67b49fb3066d6d107fa6de9dba0093c.zip
Replace HTML docs with man pages that ship with bolt
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md80
1 files changed, 0 insertions, 80 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
deleted file mode 100644
index 418958f..0000000
--- a/docs/contributing.md
+++ /dev/null
@@ -1,80 +0,0 @@
-# Contributing to Bolt
-
-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/).
-
-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.
-
-- 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.24.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
-./scripts/build.sh
-```
-
-### 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 all tests and leave database containers running:
-```
-./scripts/test.sh --keepdb
-```
-
-Run tests for a specific database:
-```bash
-./scripts/test.sh postgres
-./scripts/test.sh mysql
-./scripts/test.sh mssql
-./scripts/test.sh sqlite3
-```
-
-### Running Linters/Formatters
-
-To lint:
-```bash
-./scripts/lint.sh
-```
-
-To format:
-```bash
-./scripts/format.sh
-```