Skip to content

Commit 4774d30

Browse files
committed
doc: update contributing guidelines wrt pre-commit/devtool
Point external contributors to use devtool instead of unmaintained pre-commit script to check code quality/style. Signed-off-by: Dakshin Devanand <[email protected]>
1 parent 1ccfe46 commit 4774d30

File tree

1 file changed

+12
-28
lines changed

1 file changed

+12
-28
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -57,39 +57,23 @@ If you just want to receive feedback for a contribution proposal, open an “RFC
5757
## Contribution Quality Standards
5858

5959
Most quality and style standards are enforced automatically during integration
60-
testing. For ease of use you can setup a git pre-commit hook by running the
61-
following in the Firecracker root directory:
60+
testing. To run these quality and style checks, use `devtool`.
6261

63-
```
64-
cargo install rusty-hook
65-
rusty-hook init
66-
```
67-
68-
This project also has linters for Python and Markdown. These will be called by
69-
the pre-commit when you modify any Python and Markdown files. In order to make
70-
sure you are setup we recommend you install
71-
[poetry](https://python-poetry.org/docs/) and
72-
[pyenv](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation).
73-
74-
Poetry is used by this project and pyenv will help you make sure you have a
75-
Python version compatible with the poetry python project we use as part of
76-
`./tools/devctr`.
77-
78-
Once you have these two installed you can run the following to install the dev
79-
container poetry project:
62+
```bash
63+
# Format code (Rust, Python, Markdown)
64+
./tools/devtool fmt
8065

66+
# Check code style and lint warnings
67+
./tools/devtool checkstyle
8168
```
82-
poetry -C ./tools/devctr install --no-root
83-
```
84-
85-
Then, you can activate the poetry virtual environment by running:
8669

87-
```
88-
poetry shell -C ./tools/devctr
89-
```
70+
Refer to [docs/getting-started.md](docs/getting-started.md) and run
71+
`tools/devtool --help` for more information on `devtool`, such as build
72+
verification, tests, etc.
9073

91-
Which you will need to do after modifying python or markdown files so that the
92-
pre-commit can finish successfully.
74+
> **Note:** The legacy rusty-hook pre-commit script has been deprecated and is
75+
> unmaintained. Please use `devtool` for formatting, linting, and build checks
76+
> during your development cycle.
9377
9478
Your contribution needs to meet the following standards:
9579

0 commit comments

Comments
 (0)