Skip to content

Commit b1b02b8

Browse files
Improve project onboarding and CI
1 parent 625f030 commit b1b02b8

2 files changed

Lines changed: 43 additions & 1 deletion

File tree

.github/workflows/ci.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ["**"]
6+
pull_request:
7+
branches: ["**"]
8+
9+
concurrency:
10+
group: ci-${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
validate-skill:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v4
19+
20+
- name: Set up Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: "20"
24+
25+
- name: Validate skill structure
26+
run: node scripts/validate-skill.mjs

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,22 @@ These visuals are generated from the actual repository structure and project wor
2727
2828
Use this when an AI coding agent needs to understand a repo before editing, reviewing, testing, documenting, or designing.
2929

30+
## Why Use This Skill?
31+
32+
- Gives the agent factual project context before it starts changing files.
33+
- Separates code, design, docs, and testing lenses so scans can stay focused.
34+
- Reduces repeated manual explanations about stack, structure, conventions, and architecture.
35+
- Makes review and implementation prompts more grounded in the actual repository.
36+
37+
## Quick Start
38+
39+
```bash
40+
mkdir -p ~/.claude/skills
41+
git clone -b master-skill https://github.com/Evan1108-Coder/Project-Context-Review-Skill-Claude-Codex.git ~/.claude/skills/project-context-review
42+
```
43+
44+
For project-local Claude Code installation, Codex usage, and Claude.ai import notes, see [Installation](#installation).
45+
3046
## Best Use Cases
3147

3248
- Before implementing a feature in an unfamiliar codebase.
@@ -187,4 +203,4 @@ node scripts/validate-skill.mjs
187203

188204
## License
189205

190-
MIT. See [LICENSE](LICENSE).
206+
MIT. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)