docs: Improve CONTRIBUTING.md #800
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This text was apparently accidentally moved in 7eb8873.
There is no need to build the whole workspace, using `-p typos-dict` spares the contributor from needlessly building 261 crates.
The instructions previously instructed the contributor
to run `SNAPSHOTS=overwrite cargo test` which will however
fail when the added entry is duplicate with:
thread 'codegen' panicked at 'Duplicate present: ...'
Duplicates have to be removed by firstly running the verify
test with SNAPSHOTS=overwrite before you should try running
the code generation.
These were actually the steps before they were
changed in 7eb8873
(which appears to have been an oversight).
epage
reviewed
Aug 11, 2023
| @@ -41,11 +41,11 @@ Otherwise, to add to the dictionary: | |||
|
|
|||
| Format: `typo,correction[,correction...]` | |||
|
|
|||
| 2. Code-gen the dictionary | |||
| 2. Verify (and postprocess) the dictionary | |||
|
|
|||
| With `cargo` and `rustfmt` installed, run | |||
There was a problem hiding this comment.
This instruction is for the code-gen one
epage
reviewed
Aug 11, 2023
|
|
||
| With `cargo` and `rustfmt` installed, run | ||
| ```console | ||
| $ SNAPSHOTS=overwrite cargo test -p typos-dict | ||
| $ SNAPSHOTS=overwrite cargo test -p typos-dict verify | ||
| ``` | ||
| (we do development-time code-gen to speed up builds) |
There was a problem hiding this comment.
This belongs in the code-gen section
epage
reviewed
Aug 11, 2023
| @@ -41,11 +41,11 @@ Otherwise, to add to the dictionary: | |||
|
|
|||
| Format: `typo,correction[,correction...]` | |||
|
|
|||
| 2. Code-gen the dictionary | |||
| 2. Verify (and postprocess) the dictionary | |||
There was a problem hiding this comment.
I think the original intention was to run both steps here and then in Step 3, run the command to verify everything is resolved.
There is the annoying aspect though of needing to run verify before codegen
|
@not-my-profile, @epage It looks like this has been stale for a bit. Mind if I open a new PR to address the feedback so we can eventually get these changes through to acceptance? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please review this commit by commit and see the individual commit messages for an explanation of the changes.