Document contributor process for adding witness hint templates #933
Conversation
CONTRIBUTING.md
Outdated
| #### Adding a witness | ||
|
|
||
| **Witnesses** are a new, unstable feature of `cargo-semver-checks` that let us create witness | ||
| code, a minimal compilable example of potential downstream breakage\. They are configured via the |
There was a problem hiding this comment.
I'm curious, what's the reason for the \. everywhere? It's not something I've seen before.
There was a problem hiding this comment.
Just a bad regex find-and-replace for replacing . with . (extra spaces between periods). 😅
There was a problem hiding this comment.
Ah okay, no worries. You might need to edit my suggestions post-merge then, since I mirrored the \. style.
CONTRIBUTING.md
Outdated
| {{name}}(...); | ||
| ``` | ||
|
|
||
| which could render to something like: |
There was a problem hiding this comment.
"Render" is a bit ambiguous here.
| which could render to something like: | |
| which in the RON format could be represented like: |
CONTRIBUTING.md
Outdated
| the correct witness hints\. Note that it may contain output for other test crates - this | ||
| not necessarily an error: see the troubleshooting section for more info\. Once you've | ||
| verified that the `--- actual ---` results are as expected, copy the actual results | ||
| into the `test_outputs/witnesses/<lint_name>.output.ron` file and save\. Running |
There was a problem hiding this comment.
Is there a viable way to insta this? 🤔
There was a problem hiding this comment.
Totally! I was matching the behavior of the basic lint tests, but we could definitely use insta here, and it would probably be better for contributor experience (but less consistent)
There was a problem hiding this comment.
I imagine we'll eventually move the existing non-insta steps to insta, so probably best to start standardizing toward the new behavior we'll want eventually anyway. If someone is annoyed at the inconsistency, we can tell them we'd love a PR to move everything to insta 😅
There was a problem hiding this comment.
OK, I'll open a PR to use insta for the tests instead, then update the docs here.
suaviloquence
force-pushed
the
new-witness-doc
branch
from
fed498d
to
1651ed1
Compare
Co-authored-by: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com>
suaviloquence
force-pushed
the
new-witness-doc
branch
from
1b4de34
to
c20c5db
Compare
Adds information about the
witnessfield and when and how to add a hint template. Also sets thewitnesstoNoneinmake_new_lint.sh, with a link to this new section of the contributor docs.Rendered view