Skip to content

Add CLAUDE.md #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KOliver94 merged 2 commits into from
Nov 12, 2026
Merged

Add CLAUDE.md #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b07089
Add CLAUDE.md
KOliver94 Nov 12, 2026
073b8de
Note the interfaces and limits the repository has
KOliver94 Nov 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# CLAUDE.md

Organisation-wide defaults for Budavári Schönherz Stúdió's GitHub repositories: the settings shared by the repos listed in `settings/repos.json`, the baseline `main` ruleset, and the shared workflow checks every repo calls. [README.md](README.md) explains each part and the scripts that apply it, [docs/workflows.md](docs/workflows.md) is the workflow convention, and [SECURITY.md](SECURITY.md) is the security policy the organisation's repos inherit.

## Before calling something done

```bash
node --test "scripts/*.test.mjs"
```

This repository's own `checks.yml` calls `shared-checks.yml` from the same commit, so the PR runs any change to the checks against this repository first, except the Dependencies job, which this repository doesn't enable.

## Commits and branches

Commit messages and PR titles are plain imperative sentences. PRs are squash-merged: the PR title becomes the commit on `main`, with an empty body.

## Rules

- Live GitHub settings change only when asked: `scripts/apply-settings.mjs` and `scripts/apply-ruleset.mjs` write to the organisation's repos, so otherwise run them with `--dry-run` only.
- A repo added to `settings/repos.json` also needs the "BSStudio settings check" GitHub App installed on it, which you can't do: tell the user.
- `docs/workflows.md` and `scripts/workflow-style.mjs` stay in step: a change to the convention goes in together with the checker change that enforces it.
- A change to the shared checks reaches other repos only through a release: callers pin `shared-checks.yml` by the release commit's SHA with a `# vX.Y.Z` comment, and Renovate opens a PR in each caller for the new pin. The job names (`Workflows`, `Dependencies`) and the `dependency-review` input are an interface: every repo's ruleset requires `Checks / Workflows` by name, so renaming either blocks those PRs until every caller and ruleset is updated.
- Files in `assets/` keep their paths: other repos' READMEs embed them from `https://raw.githubusercontent.com/BSStudio/.github/main/assets/`.
Loading