binnacle 0.0.1-alpha.1

A CLI tool for AI agents and humans to track project graphs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# Contributing to Binnacle

Thank you for contributing to binnacle! This guide will help you get started.

## Development Setup

1. **Clone and build**
   ```bash
   git clone https://github.com/yourusername/binnacle.git
   cd binnacle
   cargo build
   ```

2. **Enable git hooks**
   ```bash
   git config core.hooksPath hooks
   ```

   This configures git to use the tracked hooks in the `hooks/` directory, which includes a pre-commit hook that validates:
   - Code formatting (`cargo fmt --check`)
   - Linting (`cargo clippy -- -D warnings`)

## Development Workflow

### Before Committing

The pre-commit hook will automatically run these checks, but you can run them manually:

```bash
# Run all checks
just check

# Run tests
just test

# Or individually
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-features
```

### Code Style

- Follow Rust standard formatting (enforced by `rustfmt`)
- Address all clippy warnings (CI fails on warnings)
- Write tests for new features
- Update documentation when adding/changing features

### Commit Messages

We use conventional commit style:
- `feat:` for new features
- `fix:` for bug fixes
- `docs:` for documentation changes
- `test:` for test additions/changes
- `refactor:` for code refactoring
- `chore:` for maintenance tasks

### Testing

Run the full test suite:
```bash
cargo test --all-features
```

For GUI-specific tests:
```bash
cargo test --features gui
```

### Using Binnacle to Track Binnacle Development

We dogfood! Use binnacle to track your work:

```bash
# See what's ready to work on
bn ready

# Claim a task
bn task update bn-xxxx --status in_progress

# Create linked tests
bn test create "Test feature X" --cmd "cargo test feature_x" --task bn-xxxx

# When done
bn task close bn-xxxx --reason "Implemented feature X"
```

## Pull Requests

1. Create a feature branch
2. Make your changes
3. Ensure all tests pass: `cargo test --all-features`
4. Ensure checks pass: `just check`
5. Push and open a PR
6. CI will automatically run tests, clippy, and format checks

## Questions?

Open an issue or reach out to the maintainers!