File tree Expand file tree Collapse file tree 3 files changed +24
-7
lines changed
Expand file tree Collapse file tree 3 files changed +24
-7
lines changed Original file line number Diff line number Diff line change 99 "yaml.validate" : true ,
1010 "yaml.completion" : true ,
1111 "yaml.hover" : true ,
12- "yaml.format.enable" : true
12+ "yaml.format.enable" : true ,
13+ "cSpell.words" : [
14+ " gofmt" ,
15+ " GOPATH" ,
16+ " Lipgloss" ,
17+ " Taskfile"
18+ ]
1319}
Original file line number Diff line number Diff line change @@ -13,24 +13,28 @@ Thank you for your interest in contributing to the Codebase CLI! This document p
1313### Getting Started
1414
15151 . Clone the repository:
16+
1617``` bash
1718git clone https://github.com/codebase-interface/cli.git
1819cd cli
1920```
2021
21- 2 . Install dependencies:
22+ 1 . Install dependencies:
23+
2224``` bash
2325task setup
2426```
2527
26- 3 . Build the CLI:
28+ 1 . Build the CLI:
29+
2730``` bash
2831task build
2932```
3033
3134** 📝 Note:** The ` bin/ ` directory is git-ignored. Built binaries are not committed to the repository - each developer builds locally.
3235
33- 4 . Run tests:
36+ 1 . Run tests:
37+
3438``` bash
3539task test
3640```
@@ -56,7 +60,8 @@ This project follows [Conventional Commits](https://www.conventionalcommits.org/
5660- ` chore: ` for maintenance tasks
5761
5862Examples:
59- ```
63+
64+ ``` txt
6065feat: add support for custom validation rules
6166fix: resolve issue with git branch detection
6267docs: update README with installation instructions
@@ -149,7 +154,7 @@ task docs:check
149154
150155The CLI follows a modular architecture:
151156
152- ```
157+ ``` txt
153158cmd/ # CLI commands (Cobra)
154159├── root.go # Root command
155160├── validate.go # Validation command
Original file line number Diff line number Diff line change @@ -52,18 +52,24 @@ codebase-interface validate --agent essential-files
5252## Validation Agents
5353
5454### 1. Essential Files Agent
55+
5556Validates presence of fundamental project files:
57+
5658- ** README.md** or ** README.rst** - Project documentation
5759- ** CONTRIBUTING.md** - Contribution guidelines
5860
5961### 2. Git Configuration Agent
62+
6063Validates Git configuration files:
64+
6165- ** .gitignore** - Files to ignore in Git
6266- ** .editorconfig** - Consistent coding styles
6367- ** .gitattributes** - Git attributes (optional)
6468
6569### 3. Development Standards Agent
70+
6671Validates development workflow standards:
72+
6773- ** Conventional Commits** - Commit message format
6874- ** Branch Naming** - Branch naming conventions
6975
@@ -229,7 +235,7 @@ task docs:open
229235
230236### Architecture
231237
232- ```
238+ ``` txt
233239codebase-cli/
234240├── cmd/ # Cobra CLI commands
235241│ ├── root.go # Root command
You can’t perform that action at this time.
0 commit comments