Document development workflow in README, fix Go version requirement

This commit is contained in:
2026-06-09 12:38:00 -04:00
parent ebd6619638
commit fe3ad13a91

View File

@@ -395,10 +395,30 @@ CREATE TABLE snapshot_blobs (
## requirements
* Go 1.24 or later
* Go 1.26 or later
* S3-compatible object storage
* Sufficient disk space for local index (typically <1GB)
## development workflow
All changes follow this workflow. No exceptions.
1. Create a feature branch off `main`.
2. Write tests.
3. Write the implementation.
4. Fix implementation errors until it compiles and tests pass.
5. Fix linting errors (`make lint`).
6. Update documentation and README as required by the change.
7. Format code (`make fmt`).
8. Run `make check` (lint + fmt-check + test). Fix any issues. Repeat until clean.
9. Commit on the branch.
10. Merge to `main`.
11. Push.
Do not commit directly to `main`. Do not skip steps.
Repository policies for AI agents are in [`AGENTS.md`](AGENTS.md).
## license
[MIT](https://opensource.org/license/mit/)