|
| 1 | +<!-- |
| 2 | +Sync Impact Report |
| 3 | +================== |
| 4 | +Version: 1.0.0 -> 1.1.0 (MINOR: one principle added; none removed or redefined) |
| 5 | +
|
| 6 | +Added: Principle VII, "Parked is not dead" |
| 7 | +Modified: none |
| 8 | +Removed: none |
| 9 | +
|
| 10 | +Rationale: capability that is built, works and is deliberately undeployed had no |
| 11 | +stated policy, so it was read as dead code and proposed for deletion. Both failure |
| 12 | +modes are now named -- deleting it to cheapen a refactor, and investing in it while |
| 13 | +parked. |
| 14 | +
|
| 15 | +Follow-up TODOs: none. |
| 16 | +--> |
| 17 | + |
1 | 18 | # Reactome ChatBot Constitution |
2 | 19 |
|
3 | 20 | The team is three developers covering a large surface — website, pathway browser, |
@@ -60,6 +77,26 @@ it records a decision, a measurement, or a defect someone else must judge — no |
60 | 77 | as a substitute for a fix that takes ten minutes. Three fixes are worth more than |
61 | 78 | five issues describing them. |
62 | 79 |
|
| 80 | +### VII. Parked is not dead |
| 81 | + |
| 82 | +Some capability here is built, works, and is deliberately not deployed: UniProt |
| 83 | +integration, Alliance results, and the Cross-Database profile. It runs only when a |
| 84 | +`config.yml` names it; every default is React-to-Me. |
| 85 | + |
| 86 | +Do not delete parked work to make a refactor cheaper. That trade looks like a saving |
| 87 | +and is not: the code cost someone real effort, "we are not working on it now" is not |
| 88 | +"it is dead", and rebuilding is far more expensive than carrying. This principle |
| 89 | +exists because the proposal was made -- to remove about 500 lines of UniProt and |
| 90 | +Cross-Database serving code, on the grounds that it had been dragged through three |
| 91 | +refactors in a week -- and it was wrong. |
| 92 | + |
| 93 | +Equally, do not invest in parked work. It needs no new features and no new tests. |
| 94 | +Keeping it importable and type-checking through a refactor is the whole obligation. |
| 95 | + |
| 96 | +Parked code is unexercised, so its behaviour is unverified even where it still type |
| 97 | +checks. Whoever un-parks it inherits that, and should be told at the point they find |
| 98 | +it rather than after. |
| 99 | + |
63 | 100 | ## Quality Gates |
64 | 101 |
|
65 | 102 | `main` is protected: pull request required, `enforce_admins` on, branch must be |
@@ -100,4 +137,4 @@ used for bug triage or dependency bumps, where the ceremony costs more than the |
100 | 137 | fix. Retrofitting specifications onto existing code is archaeology and is not |
101 | 138 | done. |
102 | 139 |
|
103 | | -**Version**: 1.0.0 | **Ratified**: 2026-09-08 | **Last Amended**: 2026-09-08 |
| 140 | +**Version**: 1.1.0 | **Ratified**: 2026-09-08 | **Last Amended**: 2026-09-10 |
0 commit comments