docs: merge Testing and Validation into single section
- Move Build Commands into Common Development Tasks section - Remove duplicate Validation Workflow section - Simplify document structure by consolidating build commands Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: xgopilot <noreply@goplus.org>
This commit is contained in:
34
CLAUDE.md
34
CLAUDE.md
@@ -21,23 +21,6 @@ LLGo is a Go compiler based on LLVM designed to better integrate Go with the C e
|
|||||||
|
|
||||||
For detailed dependency requirements and installation instructions, see the [Dependencies](README.md#dependencies) and [How to install](README.md#how-to-install) sections in the README.
|
For detailed dependency requirements and installation instructions, see the [Dependencies](README.md#dependencies) and [How to install](README.md#how-to-install) sections in the README.
|
||||||
|
|
||||||
## Build Commands
|
|
||||||
|
|
||||||
### Build the entire project
|
|
||||||
```bash
|
|
||||||
go build -v ./...
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build llgo command specifically
|
|
||||||
```bash
|
|
||||||
go build -o llgo ./cmd/llgo
|
|
||||||
```
|
|
||||||
|
|
||||||
### Check llgo version
|
|
||||||
```bash
|
|
||||||
llgo version
|
|
||||||
```
|
|
||||||
|
|
||||||
## Testing & Validation
|
## Testing & Validation
|
||||||
|
|
||||||
The following commands and workflows are essential when fixing bugs or implementing features in the LLGo project:
|
The following commands and workflows are essential when fixing bugs or implementing features in the LLGo project:
|
||||||
@@ -89,6 +72,11 @@ go vet ./...
|
|||||||
|
|
||||||
## Common Development Tasks
|
## Common Development Tasks
|
||||||
|
|
||||||
|
### Build the project
|
||||||
|
```bash
|
||||||
|
go build -v ./...
|
||||||
|
```
|
||||||
|
|
||||||
### Install llgo for system-wide use
|
### Install llgo for system-wide use
|
||||||
```bash
|
```bash
|
||||||
./install.sh
|
./install.sh
|
||||||
@@ -114,18 +102,6 @@ For testing purposes, you can disable GC:
|
|||||||
LLGO_ROOT=/path/to/llgo llgo run -tags nogc .
|
LLGO_ROOT=/path/to/llgo llgo run -tags nogc .
|
||||||
```
|
```
|
||||||
|
|
||||||
## Validation Workflow
|
|
||||||
|
|
||||||
When fixing bugs or implementing features, follow this workflow:
|
|
||||||
|
|
||||||
1. **Make your code changes**
|
|
||||||
2. **Write or update tests** - All bug fixes and features MUST include tests
|
|
||||||
3. **Run the test suite**: `go test ./...`
|
|
||||||
4. **Build the project**: `go build -v ./...`
|
|
||||||
5. **Test with examples**: Run relevant demos from `_demo/` directory
|
|
||||||
6. **Format code**: `go fmt ./...`
|
|
||||||
7. **Run static analysis**: `go vet ./...`
|
|
||||||
|
|
||||||
## LLGO_ROOT Environment Variable
|
## LLGO_ROOT Environment Variable
|
||||||
|
|
||||||
**CRITICAL:** Always set `LLGO_ROOT` to the repository root when running llgo during development:
|
**CRITICAL:** Always set `LLGO_ROOT` to the repository root when running llgo during development:
|
||||||
|
|||||||
Reference in New Issue
Block a user