Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add review guidelines #226

Merged
merged 3 commits into from
Dec 13, 2024
Merged

Add review guidelines #226

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24a627f
Add review guidelines
tautschnig Dec 12, 2024
e65322e
Update doc/src/general-rules.md
tautschnig Dec 12, 2024
f47d83c
Apply suggestions
tautschnig Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/src/general-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,18 @@ 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 Rust book)? Note that we
tautschnig marked this conversation as resolved.
Show resolved Hide resolved
currently focus on safety verification. Pre- and post-conditions towards
functional correctness are acceptable as long as they do not negatively
carolynzech marked this conversation as resolved.
Show resolved Hide resolved
impact verification of safety, such as over-constraining input values.
3. Is the contributed code of adequate quality and idiomatic (to the best of the
committee member's knowledge).
Loading