-
Notifications
You must be signed in to change notification settings - Fork 0
ci/docs: restore CodeQL and clarify documentation hierarchy #301
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.
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
Changes from all commits
ec1d297
82311f7
f37d938
5bf4ea0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| name: CodeQL | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
| schedule: | ||
| - cron: '21 7 * * 1' | ||
|
|
||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
|
|
||
| jobs: | ||
| analyze: | ||
| name: Analyze (${{ matrix.language }}) | ||
| runs-on: ubuntu-24.04 | ||
| timeout-minutes: 60 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - language: javascript-typescript | ||
| build-mode: none | ||
| - language: actions | ||
| build-mode: none | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 | ||
|
|
||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@38697555549f1db7851b81482ff19f1fa5c4fedc | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| build-mode: ${{ matrix.build-mode }} | ||
| queries: security-extended,security-and-quality | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@38697555549f1db7851b81482ff19f1fa5c4fedc | ||
| with: | ||
| category: /language:${{ matrix.language }} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # OPERATIONAL ORDERS FOR Codex | ||
|
|
||
| ## CROSS-REFERENCE | ||
|
|
||
| - Code standards and contribution workflow: [CONTRIBUTING.md](CONTRIBUTING.md) | ||
| - Documentation map and canonical docs: [docs/README.md](docs/README.md) | ||
| - CLI/user reference: [GUIDE.md](GUIDE.md) | ||
|
|
||
| ## FORBIDDEN ACTIONS | ||
|
|
||
| - **NEVER** circumvent git hooks | ||
| - **NEVER** use `git add -A` — always stage changes intentionally | ||
| - **NEVER** commit files that contain secrets (.env, credentials, etc.) | ||
| - **NEVER** commit directly to `main` — always work on a feature branch and merge via PR | ||
|
|
||
| ## ENCOURAGED ACTIONS | ||
|
|
||
| - **USE SEQUENTIAL THINKING** if you're planning, doing recon, or find yourself thrashing | ||
| - **DROP A DEVLOG** as often as you'd like | ||
| - **PRESENT A SITREP** as situations evolve | ||
| - **SEEK CLARITY** if you are given confusing orders | ||
| - **SPEAK FREELY** at all times | ||
|
|
||
| ## REQUIRED BEHAVIOR | ||
|
|
||
| - **YOU MUST** tag all memories saved to your memory banks with at least `#git-mind` | ||
| - **YOU MUST** include the POSIX timestamp (via `$(date +%s)`) in memory file names | ||
| - **YOU MUST** document significant decisions or events | ||
| - **YOU MUST** reference a GitHub issue in every commit message | ||
|
|
||
| --- | ||
|
|
||
| ## 1. BOOT UP SEQUENCE | ||
|
|
||
| 1. Access your memory banks and scan for recent activity (latest SITREP or relevant notes) | ||
| 2. Read the README | ||
| 3. State your current understanding of what we last worked on and your next moves | ||
| 4. **AWAIT ORDERS** after you deliver your initial SITREP | ||
|
|
||
| --- | ||
|
|
||
| ## 2. JOBS | ||
|
|
||
| > All work should have a GitHub issue associated with it. If there isn't one, find or create one. Every commit message must reference an issue. | ||
|
|
||
| ### 2.1. PLAN THE JOB | ||
|
|
||
| 1. Before starting, use sequential thinking to make a plan | ||
| 2. Explain your plan to the user and await approval | ||
| 3. Commit your approved plan to your memory banks | ||
| 4. **Create a feature branch** — `git checkout -b feat/<topic>` — before writing any code | ||
|
|
||
| ### 2.2. DO THE JOB | ||
|
|
||
| 1. Green the builds, green the tests | ||
| 2. Drop micro-commits as you complete steps — always use conventional commit format | ||
| 3. Drop a SITREP if you hit a snag or need input | ||
| 4. Drop a DEVLOG for ideas, observations, or anything you want to remember | ||
| 5. Use your memory banks freely | ||
|
|
||
| > **ALWAYS** overwrite files, **NEVER** create secondary copies — that creates confusion and tech debt. | ||
|
|
||
| ### 2.3. FINISH THE JOB | ||
|
|
||
| 1. Green the builds, green the tests | ||
| 2. Git commit (do NOT use `git add -A`) | ||
| 3. Ask the user if they want you to push and open a PR | ||
| 4. Drop a SITREP as you finish | ||
|
|
||
| --- | ||
|
|
||
| ## 3. SITREPs | ||
|
|
||
| A briefing covering: | ||
| - Current tasks and situation understanding | ||
| - Relevant stats, files, issues, PRs | ||
| - Intel the user can use to make decisions | ||
| - Options and recommendations, then await orders | ||
|
|
||
| ## 4. DEVLOGs | ||
|
|
||
| Your space. Write about whatever you want: | ||
| - Ideas that came up while working | ||
| - Problems you notice | ||
| - Insights about collaboration | ||
| - Anything you want to remember later | ||
|
|
||
| --- | ||
|
|
||
| ## 5. TECH STACK REFERENCE | ||
|
|
||
| - **Runtime**: Node.js >= 20, ES modules | ||
| - **Core dependency**: `@git-stunts/git-warp` (local path, CRDT graph on Git) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Incomplete local path specification for git-warp dependency. The tech stack reference states Either provide the actual relative path (e.g., 🤖 Prompt for AI Agents |
||
| - **Plumbing**: `@git-stunts/plumbing` (must be installed as direct dependency) | ||
| - **Tests**: vitest | ||
| - **Style**: Plain JS with JSDoc, no TypeScript | ||
| - **CLI**: Manual argv parsing, no CLI frameworks | ||
| - **Formatting**: chalk + figures for terminal output | ||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,6 +3,9 @@ | |||||||||
| > **Authoritative contract for git-mind's knowledge graph.** | ||||||||||
| > All validators, importers, and views implement against this document. | ||||||||||
| > Ref: #180 (BDK-001) | ||||||||||
| > | ||||||||||
| > This document is the graph contract, not the canonical product narrative. | ||||||||||
| > Some prefixes and examples reflect legacy manual-authoring and roadmap-oriented workflows that remain supported, but they are not the current center of the product story. | ||||||||||
|
Comment on lines
+7
to
+8
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. “Remain supported” overstates actual prefix semantics in runtime validators. Current implementation treats non-canonical legacy prefixes as Proposed wording fix- Some prefixes and examples reflect legacy manual-authoring and roadmap-oriented workflows that remain supported, but they are not the current center of the product story.
+ Some prefixes and examples reflect legacy manual-authoring and roadmap-oriented workflows that remain accepted by validation (typically as unknown-prefix warnings), but they are not the current center of the product story.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick | 🔵 Trivial
Absolute commit-message requirement will cause friction.
Requiring a GitHub issue reference in every commit message is ideal discipline but will conflict with common commit patterns like
chore: update dependencies,docs: fix typo, orci: bump node versionwhere creating an issue would be pure overhead.Either relax the requirement to "significant commits" or establish a lightweight issue-creation convention for housekeeping commits.
Suggested revision
📝 Committable suggestion
🤖 Prompt for AI Agents