Skip to content
This repository was archived by the owner on Jan 26, 2025. It is now read-only.

Commit 9e5e63c

Browse files
tingerrrtingerrr
authored andcommitted
chore: add doc test back to ci recipe
1 parent 19915b2 commit 9e5e63c

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,19 @@ Any contributions are welcome, from implementing large features to fixing small
1616
1. Once reviewed it is either squashed and merged, or rebased on main.
1717

1818
## Commit Messages
19-
Each of the final commits should have a clear commit message starting with `a(b):`, where `a` is a general term like:
19+
Each of the final commits should have a clear commit message starting with a prefix indicating what was done:
2020
- `fix` for fixing bugs
2121
- `docs` for changing, fixing or adding new documentation
2222
- `feat` for a new feature of any kind
2323
- `chore` for anything else like cleanups or refactors, these should not have any externally observable change in behavior (other than speed ups)
24-
25-
`b` is optional, but may be a term like:
2624
- `cli` for change to the cli crate
2725
- `lib` for changes to the library crate
2826
- `book` for changes to the book
2927
- `ci` for changes to ci workflows
3028
- `vcs` for changes to features regarding VCS
31-
- a path to a file for various other changes concerning specific things like scripts (rarely used)
32-
- a path to module or type in the code base (`lib::test::Test`/`lib::Test`) for very specific refactors
29+
- etc.
30+
31+
Prefixes can be chanined like `fix: cli: ...` to make it clear that a fix was cli specific.
3332

3433
This is generally optional, but helps developers filter out commits when bug hunting.
3534
After this should follow a short summary of what the commit changes followed by a more elaborate description.

Justfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ run *args='--release':
1919

2020
# run tests and checks similar to CI
2121
ci $RUSTFLAGS='-Dwarnings' $RUSTDOCFLAGS='-Dwarnings':
22-
# FIXME: See https://github.com/rust-lang/rust/issues/128538
23-
# add back doc tests by removing --all-targets
24-
cargo +1.80 test --workspace --all-targets
22+
# FIXME(tinger): See https://github.com/rust-lang/rust/issues/128538 if you get
23+
# high CPU doc tests
24+
cargo +1.80 test --workspace
2525
cargo +1.80 clippy --workspace
2626
cargo +1.80 fmt --all --check
2727
cargo +1.80 doc --workspace --no-deps

0 commit comments

Comments
 (0)