aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-10-10 22:42:23 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-10-10 22:42:23 -0400
commit0bd9e2f5fd809c8be3e31436ca8739e4ee765397 (patch)
treeb84d4816d451f9efa01647f05d949d9f083e708f
parentRemove email workflow docs from contrib guide (diff)
downloadcli-0bd9e2f5fd809c8be3e31436ca8739e4ee765397.zip
Add note on contributing guide to README
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 70a19b3..5ddde69 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,7 @@ It is distributed as a standalone binary, making it easy to run anywhere without
- [Why can't I change between version styles?](#why-cant-i-change-between-version-styles)
- [How is the migration message used?](#how-is-the-migration-message-used)
- [What restrictions are there on the custom migration table?](#what-restrictions-are-there-on-the-custom-migration-table)
+- [Contributing](#contributing)
## Features
@@ -550,3 +551,8 @@ All migrations are created on the local filesystem in the format `<version>_<mes
### What restrictions are there on the custom migration table?
While you can configure the database table that bolt uses for keeping track of applied migrations, there are restrictions on the name that can be used. It must only contain alphanumeric or underscore characters (e.g. `my_custom_table`). Furthermore, it _may_ contain one dot (`.`) if you would like to specify a different schema (e.g. `different_schema.my_custom_table`). However, do note that using a custom schema is only support with MSSQL and PostgreSQL since MySQL and SQlite3 both don't support schemas.
+
+## Contributing
+
+For information on how to contribute to Bolt, see the [Contributing
+Guide](./CONTRIBUTING.md).