You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- All code produced via agentic AI **must be disclosed in the PR**. Use: `Assisted-by: <tool>:<model>`.
8
+
- **The PR description, along with subsequent PR discussion comments, must be human-written.**
9
+
10
+
See our [guide on Verus contributions](https://github.com/verus-lang/verus/blob/main/CONTRIBUTING.md) for more details.
11
+
-->
12
+
3
13
<small>By submitting this pull request, I confirm that my contribution is made under the terms of the [MIT license](https://github.com/verus-lang/verus/blob/main/LICENSE).</small>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Tips for Contributing to Verus
1
+
# Tips and Expectations for Contributing to Verus
2
2
3
3
Thanks for contributing to Verus! Verus is an Open Source project and welcomes
4
4
contributions. Please report issues or start discussions here on GitHub.
@@ -16,6 +16,28 @@ To record an execution run, simply add `--record` to the verus command that trig
16
16
17
17
If you want to aid us in debugging (or are unable to share your full recording, which includes the full crate for us to be able to reproduce your issue), you can attempt to minimize the issue before recording it. For automatic minimization of a crate or file (producing a smaller file that triggers the same error), see [source/tools/minimizers/README.md](./source/tools/minimizers/README.md) for more details.
18
18
19
+
## Expectations when making a contribution
20
+
21
+
Verus is a verification tool, but it is not itself verified, so we use traditional software methods like testing and human review to ensure quality. Therefore, we have high standards for code changes.
22
+
23
+
As a new contributor, you should expect at least one review from a core contributor (e.g., @tjhance, @Chris-Hawblitzel, or @parno). The first reviewer will also determine if additional reviews are necessary.
24
+
25
+
In the PR description, please describe:
26
+
- What issue you're solving (please include a link to an existing GitHub issue if it exists)
27
+
- Changed behavior, if any
28
+
- A description of your code changes
29
+
30
+
For *opinionated changes*, such as those that add a feature or dramatically modify code architecture, we would highly recommend checking with the Verus team first (by opening a [GitHub Discussion](https://github.com/verus-lang/verus/discussions)) to save time and to ensure the direction is a desirable one.
31
+
32
+
### Policy for AI-generated and AI-assisted code
33
+
34
+
AI use is permitted, but all code produced via agentic AI must be disclosed in the PR. Regardless of how the code is produced, we expect the human contributor to take responsibility for the quality of the code. As a consequence of this position, **do not** list any tool (AI or otherwise) as a co-author. Instead, you can use `Assisted-by: <tool>:<model>`.
35
+
36
+
AI-assisted coding, or "vibecoding," carries a number of risks. These risks include both damage to overall code quality and the risk of overburdening the reviewers, as code can be generated faster than it can be reviewed. We will close a PR if we feel those risks cannot be satisfactorily managed, or if our time is abused.
37
+
38
+
We expect professionalism and common sense from contributors; you, the human author, are responsible for the pull request. Be prepared to receive feedback or to answer questions about the PR. **The PR description, along with subsequent PR discussion comments, must be human-written in all cases.**
39
+
40
+
19
41
## Building Verus from Source
20
42
21
43
**See [BUILD.md](BUILD.md) for how to build Verus from source.**
0 commit comments