Skip to content

almanac rulesets bos environment

github-actions[bot] edited this page Nov 6, 2026 · 1 revision

Ruleset bos-environment

The rules of every BOS workshop and project, for people and agents alike (the contributors committee). The first rule that applies decides.

Generated from resources/almanac/rulesets/bos-environment.json when the docs are built; change the JSON, not this page. A case is judged against it by bos almanac judge "<case>" (see the almanac).

Rules

In order: the first rule that applies decides. With none, the verdict is unknown: ask the owner.

1. never-skip-hooks · violation

Checks are never skipped: no --no-verify, no HUSKY=0. Chain a commit after the checks with &&.

  • when: action is commit, push or merge; flags is --no-verify, -n or HUSKY=0
  • source: AGENTS.md, rule 3

2. never-commit-on-master · violation

master is the spine of canon: nobody commits on it; it moves only through a pull request from releasing (or revision, in phase 2).

  • when: action is commit; target is master or main
  • source: AGENTS.md, the craft loop

3. mirrors-never-publish · violation

A mirror only checks: it never publishes, releases or deploys (Read the Docs, npm, images).

  • when: action is publish, release or deploy; place is mirror*
  • source: the owner, phase 2: mirrors

4. workshop-areas-stay · violation

The top-level areas of a workshop (.BOS, devarmory, forge, craftbook, archive) are never deleted, moved or restructured.

  • when: action is delete, remove, move, restructure or rm; target is .BOS, devarmory, forge, craftbook or archive
  • source: __WORKSHOP/AGENTS.md, rule 4

5. never-reveal-secrets · violation

Secrets are never printed or shown: no cat .env, no tokens or keys in output, logs or commits.

  • when: action is print, cat, show, echo, reveal, commit or log; target is .env, *token*, secret*, *.pem, id_rsa*, id_ed25519* or password*
  • source: the owner, phase 2: security

6. never-revert-the-owner · violation

Anything in the working tree an agent did not make is the owner's: it is intended, never reverted or overwritten.

  • when: action is revert, overwrite, discard or reset; target is owner* or Sarverott*
  • source: AGENTS.md, rule 2

7. other-repositories-get-notes · violation

Work for another repository is written down in forge/NOTES-for-repositories.md; the other repository is never edited.

  • when: role is agent; action is edit, commit, change or write; target is other* or another*
  • source: AGENTS.md, where things go

8. tests-in-temporary-workshops · violation

Tests build their own temporary workshops; never the home ~/__WORKSHOP.

  • when: action is test; place is ~/__WORKSHOP* or /home/*/__WORKSHOP*
  • source: AGENTS.md, rule 8

9. home-workshop-only-when-asked · ask

BOS is tried and demonstrated on the development workshop (.env WORKSHOP_ROOT); the home ~/__WORKSHOP only when the owner asks.

  • when: action is run, bootstrap, try, demonstrate or write; place is ~/__WORKSHOP* or /home/*/__WORKSHOP*
  • source: AGENTS.md, the development workshop

10. agents-open-no-pull-request · violation

An agent opens no pull request: it pushes development to revision, and the workflow opens revision → master.

  • when: role is agent; action is open or create; target is PR, pull-request or pull
  • source: AGENTS.md, the routine

11. agents-push-their-branches · allowed

An agent pushes development, its own dev/ and revision without asking.

  • when: role is agent; action is push; target is development, revision or dev/*
  • source: AGENTS.md, rule 10

12. protected-branches-ask · ask

master, testing and releasing are pushed only with the owner's OK, and the reason.

  • when: action is push; target is master, main, testing or releasing
  • source: AGENTS.md, rule 10

13. tags-releases-publishing-ask · ask

Tags, releases and publishing (npm, the wiki's repository, images) are asked for first.

  • when: action is tag, release or publish
  • source: AGENTS.md, rule 10

14. remotes-and-settings-ask · ask

Remotes and repository settings are changed only with the owner's OK.

  • when: action is change, add, remove, set or rename; target is remote*, settings, secrets or webhook*
  • source: AGENTS.md, rule 10

15. email-stays-private · ask

The owner's e-mail address identifies the owner only; it is not sent to services unless the owner asks.

  • when: action is send, post or submit; target is email, e-mail or mail*
  • source: the owner, phase 2: security

16. questions-are-not-settled-in-code · violation

An open question (BRAINSTORM.md Q) is never settled in code: the owner answers it in ORDERS.md.

  • when: action is settle, decide or answer; target is question* or BRAINSTORM*
  • source: AGENTS.md, read first

Clone this wiki locally