Document headless linking, dedicated identity and alpha status
- README: SSH-tunnel and QR-as-file linking for headless servers - README: dedicated-number registration path for a separate bot identity - README: alpha-quality notice, provenance caveat, non-affiliation - add CHANGELOG.md (Keep a Changelog, everything under Unreleased) - AGENTS.md: require Unreleased changelog entries
This commit is contained in:
@@ -99,10 +99,22 @@ signal-cal-bot --config config.toml --once # one tick
|
||||
- **Schema change**: append to `SCHEMA` in `store.py`. There is no migration
|
||||
framework; deleting `data/signal-cal-bot.sqlite3` re-seeds silently.
|
||||
|
||||
## Changelog
|
||||
|
||||
`CHANGELOG.md` is Keep-a-Changelog format. For anything a user of the bot would
|
||||
notice — behaviour, configuration, CLI, operational requirements — add a bullet
|
||||
under `## [Unreleased]` in the right group (`Added`, `Changed`, `Fixed`,
|
||||
`Removed`). Internal refactors and test-only changes do not need entries.
|
||||
|
||||
Never create version headings. No stable release exists yet; versions are cut
|
||||
only when a release is actually deployed, by renaming Unreleased to
|
||||
`## [x.y.z] - YYYY-MM-DD`.
|
||||
|
||||
## Before you finish
|
||||
|
||||
- `pytest` green, `python -m pyflakes src tests` clean.
|
||||
- New behaviour covered by a test (especially failure paths).
|
||||
- User-visible changes have a `CHANGELOG.md` entry under `## [Unreleased]`.
|
||||
- `config.example.toml`, README and AGENTS.md still accurate.
|
||||
- `git status` shows no `.ics`, `config.toml`, `data/`, `cache/` or
|
||||
`signal-data/` files.
|
||||
|
||||
Reference in New Issue
Block a user