blob: 5b0995d67f9a68183972cda32e35ab0e0f113224 [file] [log] [blame] [view]
Johnathan Van Why3a786cb2020-07-07 12:16:35 -07001Code Review
2===========
3
4## Code Review Practices
5
6PR to `libtock-rs` can be divided into two categories:
7
81. **Upkeep pull requests** are minor changes to existing functionality.
9 Examples include bug fixes (that do not significantly affect APIs) and
10 documentation that describes an existing implementation.
111. **Significant pull requests** are pull requests that are too substantial to
12 be considered upkeep pull requests. Significant pull requests may include new
13 functionality, API changes, significant refactoring, new tooling, and other
14 changes.
15
16The owners of `libtock-rs` (listed [below](#owners)) determine whether a PR is
17an upkeep PR or a significant PR. PRs should be merged by the `libtock-rs`
18owners rather than the PR's author. PRs authored by `libtock-rs` owners should
Johnathan Van Whyac83d582020-07-10 14:49:03 -070019be merged by a reviewer rather than their author. In general, PRs should be
20merged using a `bors r+` command rather than the GitHub UI (see the [bors
21documentation](https://bors.tech/documentation/) for more information on bors).
Johnathan Van Why3a786cb2020-07-07 12:16:35 -070022
23A PR may only be merged when all of the following are true:
24
251. At least one `libtock-rs` owner (who is not the PR author) has approved the PR.
261. All outstanding review discussions have been resolved.
271. If the pull request is significant, a 7 day waiting period has passed since
28 the PR was opened.
29
Johnathan Van Whyac83d582020-07-10 14:49:03 -070030We recommend that authors of significant PRs comment on the PR when they believe
31the above criteria have been satisfied (including the waiting period). This is
32primarily to remind the owners to merge the PR. Secondarily, it should help
33identify confusion about a PR review's status.
34
Johnathan Van Why3a786cb2020-07-07 12:16:35 -070035## Owners
36
37The owners of `libtock-rs` are:
38
39* The [Tock Core Working
40 Group](https://github.com/tock/tock/tree/master/doc/wg/core#members).
41* Alistair Francis, [alistair23](https://github.com/alistair23), Western Digital
42* [torfmaster](https://github.com/torfmaster)
43* [Woyten](https://github.com/Woyten)