Skip to content

Commit

Permalink
Add review guidelines (#226)
Browse files Browse the repository at this point in the history
Extends committee membership information with guidance on what is
expected of committee members.

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 and MIT licenses.

---------

Co-authored-by: Carolyn Zech <[email protected]>
  • Loading branch information
tautschnig and carolynzech authored Dec 12, 2024
1 parent 955577c commit 15a8e65
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/src/general-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,21 @@ members = [
+ "rahulku"
]
```

Committee members are expected to contribute by reviewing pull requests (all
pull requests review approvals from at least two committee members before they
can be merged).
Reviews of solutions towards challenges should consider at least the following aspects:

1. Does the pull request implement a solution that respects/meets the success
criteria of the challenge?
2. Do the contracts and harnesses incorporate the safety conditions stated in
the documentation (from comments in the code and the
[standard library documentation](https://doc.rust-lang.org/std/index.html))?
Note that we currently focus on safety verification. Pre- and post-conditions
towards functional correctness are acceptable as long as they do not
negatively impact verification of safety, such as over-constraining input
values or causing excessive verification run time.
3. Is the contributed code of adequate quality, idiomatic, and stands a chance
to be accepted into the standard library (to the best of the committee
member's knowledge)?

0 comments on commit 15a8e65

Please sign in to comment.