kaslo/synapse
1
0
Fork 0
Code Wiki Activity

Tell agents about docs/upgrade.md

Browse Source
This commit is contained in:
Andrew Morgan
2025-06-06 14:02:32 +01:00
committed by Andrew Morgan
parent 3305c45817
commit ef0f62330e
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
AGENTS.md
View File

@@ -7,6 +7,9 @@ Synapse is a Python application that has Rust modules via pyo3 for performance.
- Run `poetry install --dev` to install development python dependencies. This will also build and install the Synapse rust code.
- Use `./scripts-dev/lint.sh` to lint the codebase (this attempts to fix issues as well). This should be run and produce no errors before every commit.
## Dev Tips
- If any change creates a breaking change or requires downstream users (sysadmins) to update their environment, call it out in `docs/upgrade.md` as a new entry with the title "# Upgrading to vx.yy.z" with the details of what they should do or be aware of.
## Testing Instructions
- Find the CI plan in the .github/workflows folder.
- Use `poetry run trial tests` to run all unit tests, or `poetry run trial tests.metrics.test_phone_home_stats.PhoneHomeStatsTestCase` (for example) to run a single test case. The commit should pass all tests before you merge.