Skip to content

Commit 6a9ce15

Browse files
committed
chore: update docs
1 parent 04cad99 commit 6a9ce15

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

book/src/contributing.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@ This is the standard contribution/development guidelines for the project. You ma
44

55
## Table of Contents
66

7-
- [Getting Started](#getting-started)
8-
- [Production Release Workflow](#production-release-workflow)
7+
- [Requirements](#requirements)
8+
- [Production Workflow](#production-workflow)
99
- [Pull Request Guidelines](#pull-request-guidelines)
1010
- [License](#licensing)
1111

12-
## Getting Started
13-
14-
The commonplace of contributing is to first clone the repository and install the dependencies.
12+
## Requirements
1513

1614
The prerequisites are as follows:
1715

@@ -34,23 +32,19 @@ $ git clone git@github.com:<username>/cutler.git
3432

3533
Replace `<username>` with your GitHub username.
3634

37-
### Preparing the Environment
35+
### Required Rust Components
3836

39-
Working on this project will require a few Rust components beforehand:
37+
Make sure your environment has these tools (NOTE: This list can change based on what currently suits the project).
4038

4139
- [clippy](https://github.com/rust-lang/rust-clippy)
4240
- [rustfmt](https://github.com/rust-lang/rustfmt)
4341

44-
## Production Release Workflow
42+
## Production Workflow
4543

46-
This chain of commands can be used to fully test and build the final product.
44+
CI/CD for cutler is done using [GitHub Actions](https://docs.github.com/en/actions). You may find these workflows useful to look at:
4745

48-
### Testing
49-
50-
```sh
51-
# raw command
52-
cargo fmt --all -- --check && cargo test --verbose && cargo clippy && cargo build
53-
```
46+
- Release: [.github/workflows/release.yml](https://github.com/cutlerCLI/cutler/blob/master/.github/workflows/release.yml)
47+
- Unit tests: [.github/workflows/tests.yml](https://github.com/cutlerCLI/cutler/blob/master/.github/workflows/tests.yml)
5448

5549
> The unit tests in the CI workflow are done using an **Apple Silicon M1 (3-core)** runner provided by GitHub Actions. See [this page](https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) in GitHub's documentation for more information on all the runners. If the runners used in this project get outdated and don't get a bump, you may suggest one through [GitHub Issues](https://github.com/cutlerCLI/cutler/issues/new).
5650
@@ -59,7 +53,7 @@ cargo fmt --all -- --check && cargo test --verbose && cargo clippy && cargo buil
5953
You can easily create a release build for cutler using the following command:
6054

6155
```sh
62-
cargo build --release --verbose --locked
56+
cargo build --release --locked
6357
```
6458

6559
The major part of the release automation is currently done with [GitHub Actions]() via the [following workflow](./.github/workflows/release.yml) so, you can have a look at it to view the entire pipeline.
@@ -68,10 +62,14 @@ The unit testing is done via [this workflow.](https://github.com/cutlerCLI/cutle
6862

6963
### Code Formatting
7064

71-
`cutler` uses basic Rust formatting for code reliability and maintainability. This ensures that the codebase remains clean, readable, and consistent across different contributors.
65+
The project uses core Rust tools to format and prettify the codebase:
7266

7367
```sh
68+
# For global formatting
7469
cargo fmt --all
70+
71+
# For code quality
72+
cargo clippy --fix
7573
```
7674

7775
## Pull Request Guidelines

0 commit comments

Comments
 (0)