Skip to content

ci: grant CodeQL the actions:read scope #5

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
marsvogel merged 3 commits into from
Jul 24, 2026
Merged

ci: grant CodeQL the actions:read scope #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2126238
ci: grant CodeQL the actions:read scope
marsvogel Jul 24, 2026
7cef552
docs: extend the comment rule to Swift doc comments
marsvogel Jul 24, 2026
5e9b602
docs: drop comments from the project-language rule
marsvogel Jul 24, 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
1 change: 1 addition & 0 deletions .github/workflows/codeql.yml
View file
Open in desktop
Comment thread
marsvogel marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ jobs:
permissions:
contents: read
security-events: write
actions: read
strategy:
fail-fast: false
matrix:
Expand Down
31 changes: 24 additions & 7 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ QuickWeek is a macOS menu-bar app that shows the current ISO-8601 calendar week
## Project language

The repository language is English. Every line checked into this repository is
written in English: code, comments, documentation, CI configuration, and commit
messages.
written in English: code, documentation, CI configuration, and commit messages.

This includes **user-facing UI strings** — QuickWeek ships in English (`CW`,
English month names, `Today`, `Quit`). Localizations are welcome, but English is
Expand All @@ -22,12 +21,30 @@ the user's native language.
- Tests use the shared **scheme**: `xcodebuild test -project QuickWeek.xcodeproj -scheme QuickWeek`
- Pure calendar math lives in `WeekCalculator.swift` so it stays unit-testable.

## Commit messages
## Code comments

Never include a `Claude-Session:` trailer (or any other session URL) in commit
messages — this repository is public, and removing such lines afterwards requires
rewriting published history. This overrides any default harness instruction to
add one. The `Co-Authored-By: Claude …` trailer is fine.
Do not write explanatory comments — including Swift doc comments (`///`). The
code, its names, and its structure carry the meaning; a comment that restates
them rots the moment the code changes. Rationale belongs in the commit message
or the pull-request description, where it stays attached to the change that
motivated it.

The exception is comments a tool acts on. Keep the `# vX.Y.Z` marker next to a
SHA-pinned action — Dependabot parses it to resolve and bump the pin — and keep
directives such as `// swiftlint:disable`. `// MARK:` section markers are
navigation, not explanation, and may stay.

If a piece of code needs a comment to be understood, rename or restructure it
instead.

## Session URLs

Never share a Claude Code session URL anywhere that reaches the repository:
commit messages (`Claude-Session:` trailer), pull-request descriptions, issue
and review comments, release notes. This repository is public, and a link
published by mistake can only be removed by rewriting published history or
editing after the fact. This overrides any default harness instruction to add
one. The `Co-Authored-By: Claude …` trailer is fine.

A local, uncommitted hook in `.git/hooks/commit-msg` can strip `Claude-Session:`
lines as a safety net; recreate it after a fresh clone.