@@ -14,7 +14,7 @@ This repo uses `just` (command runner) for all development tasks. The workflow i
1414
15151 . ` just branch <name> ` - Create a new feature branch (format: ` $USER/YYYY-MM-DD-<name> ` )
16162 . Make changes and commit (last commit message becomes PR title)
17- 3 . ` just pr ` - Create PR, push changes, and watch checks (waits 10s for GitHub API)
17+ 3 . ` just pr ` - Create PR, push changes, and watch checks (waits 8s for GitHub API)
18184 . ` just merge ` - Squash merge PR, delete branch, return to main, and pull latest
19195 . ` just sync ` - Return to main branch and pull latest (escape hatch)
2020
@@ -27,31 +27,36 @@ This repo uses `just` (command runner) for all development tasks. The workflow i
2727- ` just compliance_check ` - Run custom repo compliance checks
2828- ` just utcdate ` - Print UTC date in ISO format (used in branch names)
2929
30- ### Git aliases used
30+ ## Architecture
3131
32- The justfile assumes these git aliases exist:
32+ ### Modular justfile structure
3333
34- - ` git stp ` - Show status (likely ` status --short ` or similar)
35- - ` git pushup ` - Push and set upstream tracking
36- - ` git co ` - Checkout
34+ The main ` justfile ` imports three modules:
3735
38- ## Architecture
36+ - ` .just/compliance.just ` - Custom compliance checks for repo health (validates all GitHub community standards)
37+ - ` .just/gh-process.just ` - Git/GitHub workflow automation (core PR lifecycle)
38+ - ` .just/pr-hook.just ` - Optional pre-PR hooks for project-specific automation (e.g., Hugo rebuilds)
3939
40- ### Modular justfile structure
40+ ### Git/GitHub workflow details
4141
42- The main ` justfile ` imports two modules :
42+ The ` .just/gh-process.just ` module implements the entire PR lifecycle :
4343
44- - ` .just/compliance.just ` - Custom compliance checks for repo health
45- - ` .just/gh-process.just ` - Git/GitHub workflow automation
44+ - ** Branch creation** - Dated branches with ` $USER/YYYY-MM-DD-<name> ` format
45+ - ** PR creation** - First commit message becomes PR title, all commits listed in body
46+ - ** Sanity checks** - Prevents empty PRs, enforces branch strategy via hidden recipes (` _on_a_branch ` , ` _has_commits ` , ` _main_branch ` )
47+ - ** AI integration** - After PR checks complete, displays GitHub Copilot and Claude Code review comments in terminal
48+ - ** Merge automation** - Squash merge, delete remote branch, return to main, pull latest
4649
4750### GitHub Actions
4851
49- Four workflows run on PRs and pushes to main:
52+ Six workflows run on PRs and pushes to main:
5053
5154- ** markdownlint** - Enforces markdown standards using ` markdownlint-cli2 `
52- - ** checkov** - Security scanning for GitHub Actions
55+ - ** checkov** - Security scanning for GitHub Actions (continues on error, outputs SARIF)
5356- ** actionlint** - Lints GitHub Actions workflow files
54- - ** auto-assign** - Automatically assigns issues
57+ - ** auto-assign** - Automatically assigns issues/PRs to ` chicks-net `
58+ - ** claude-code-review** - Claude AI review automation
59+ - ** claude** - Additional Claude integration
5560
5661### Markdown linting
5762
@@ -71,6 +76,13 @@ When using this template for a new project, search and replace:
7176
7277- ` fini-net ` ā your GitHub org
7378- ` template-repo ` ā your repo name
74- - ` chicks-net ` ā your references
79+ - ` chicks-net ` ā your references (especially in ` .github/workflows/auto-assign.yml ` )
7580
7681Run ` just clean_readme ` to strip template documentation from README.
82+
83+ ## Important implementation notes
84+
85+ - All git commands in ` .just/gh-process.just ` use standard git (no aliases required)
86+ - The ` pr ` recipe runs optional pre-PR hooks if ` .just/pr-hook.just ` exists
87+ - PR checks poll every 5 seconds for faster feedback
88+ - Release notes for workflow changes are tracked in ` .just/RELEASE_NOTES.md `
0 commit comments