Skip to content

Commit 7cdb26f

Browse files
committed
chore: vibe
1 parent 697fe3d commit 7cdb26f

2 files changed

Lines changed: 22 additions & 24 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@ just setup
5050
### Development Workflow
5151

5252
1. Work on the issue and write unit tests
53-
- Add Solidity test files to `tests/contract-playground/` as needed
53+
- Add Solidity test files to `tests/contract-playground/` for small additions
54+
- For larger test cases, create your own project under `tests/`. Prefer projects without external dependencies—use `forge init --no-git` for a minimal Foundry setup
5455
- Run specific tests with `cargo test <test-name>`
5556

56-
2. Generate reports to verify your changes
57+
2. Generate reports to verify your changes using `cargo prep`. This command runs Aderyn against test projects and outputs baseline reports to `reports/`. These reports are committed to the repo, and CI verifies that your changes produce the expected output.
5758
```bash
5859
cargo prep -n playground # Generate report for contract-playground
5960
cargo prep # Show all available test projects
@@ -64,26 +65,12 @@ just setup
6465
cargo blesspr # Run all checks to satisfy CI
6566
```
6667

67-
4. Open a pull request to the `dev` branch. A maintainer (@alexroan or @TilakMaddy) will review it.
68-
69-
### Code Quality
70-
71-
If you are not running `cargo blesspr` due to the small scope of your changes, run these commands to fix formatting and lint issues:
72-
```bash
73-
cargo fixfmt
74-
cargo fixclippy
75-
```
76-
77-
### Advanced Setup (Optional)
68+
> **Quick fixes only?** For small changes, you can skip the full `blesspr` and just run:
69+
> ```bash
70+
> cargo fixfmt && cargo fixclippy
71+
> ```
7872
79-
For a better development experience, install [Bacon](https://dystroy.org/bacon/) and run `bacon` at the project root. Keyboard shortcuts:
80-
81-
| Key | Action |
82-
|-----|--------|
83-
| `t` | Run tests |
84-
| `r` | Generate report for contract-playground |
85-
| `a` | Generate all reports in parallel |
86-
| `Alt-b` / `⌥-b` | Bless the PR (run all CI checks) |
73+
4. Open a pull request to the `dev` branch. A maintainer (@alexroan or @TilakMaddy) will review it.
8774
8875
### Adding a Test Project
8976

bacon.toml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
# This is a configuration file for the bacon tool
1+
# Bacon configuration for Aderyn development
2+
# https://dystroy.org/bacon/
23
#
34
# Complete help on configuration: https://dystroy.org/bacon/config/
5+
# Default config: https://github.com/Canop/bacon/blob/main/defaults/default-bacon.toml
46
#
5-
# You may check the current default at
6-
# https://github.com/Canop/bacon/blob/main/defaults/default-bacon.toml
7+
# Install: cargo install bacon
8+
# Run: bacon (at project root)
9+
#
10+
# Keyboard shortcuts:
11+
# t Run tests
12+
# r Generate report for contract-playground
13+
# a Generate all reports in parallel
14+
# Alt-b Bless the PR (run all CI checks)
15+
# c Run clippy
16+
# f Check formatting
17+
# d Open docs
718

819
default_job = "clippy-display-warnings"
920
env.CARGO_TERM_COLOR = "always"

0 commit comments

Comments
 (0)