mirror of
https://github.com/storytold/photocraft.git
synced 2026-11-19 08:51:41 +01:00
Merge pull request #15343 from davidmann4/docs/agents-naming-rules
docs(agents): link the names rule from craft-contrib (#15342)
This commit is contained in:
1 file changed
+1
@@ -123,6 +123,7 @@ People trust PhotoCraft with their work, and a crash loses it. A malformed file,
|
||||
8. **Performance is a feature.** Benchmark heavy operations on a 24–36 MP image in release. Work per tile in parallel (rayon), skip empty tiles, never scan a full surface per frame (cache per revision), and record before/after timings in the dev log.
|
||||
|
||||
9. **Never panic on input** (see *Never crash* above). A command's `run` closure and anything it calls must return `Err`, never panic, for *any* params or document state: validate params, check bounds before indexing or dividing, and reject absurd sizes before allocating. The `panic_hunt` integration test fuzzes every command with adversarial params and must stay green.
|
||||
10. **Our features use our own names.** Labels, menus, dialogs, messages, tooltips, help, READMEs, release text and every translation never name a feature with another company's product, technology or distinctive feature name. Ordinary descriptive words that several unrelated products use for the same thing (`Layers`, `Crop`) are fine. Parity means the same place and behaviour, not the same name. Follow [standards/naming.md](https://github.com/storytold/craft-contrib/blob/main/standards/naming.md) ([RFC-0029](https://github.com/storytold/craft-contrib/blob/main/rfcs/0029-other-companies-names.md)): take the name from its names list, run its check for any other new or changed name and record it in the pull request and in `docs/feature-names.md`, and when the check does not settle it, do not ship the name. Change labels only: command ids, preference keys and stored values keep their names, and the old label stays as a hidden search alias. File formats and compatibility names stay accurate (`Open PSD`).
|
||||
|
||||
## 4. Picking work
|
||||
|
||||
|
||||
Reference in new issue
Block a user