Skip to content

Commit 9d361c6

Browse files
authored
simplify review workflow (#927)
1 parent 43958f6 commit 9d361c6

1 file changed

Lines changed: 17 additions & 47 deletions

File tree

README-TEAM.md

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Team processes
22

3+
## Privs
4+
5+
Privs should be assigned on a group basis, rather than granted to indivuals.
6+
7+
## Conventions
8+
9+
Branch names should be of the form `NNNN-short-description`, where `NNNN` is the issue number being addressed.
10+
11+
Add developer-only dependencies in `requirements-dev.in`; Add other dependencies in `requirements.in`. After an edit to either file run `scripts/requirements.py` to install the new dependency locally and update `pyproject.toml`.
12+
13+
## Review
14+
15+
"Draft" can be used to indicate that a PR isn't quite ready for review.
16+
If it's not "draft" a reviewer should be assigned.
17+
18+
If the situation calls for it, PRs can be stacked, but we'll try to keep things simple.
19+
320
## Release
421

522
### PyPI
@@ -26,50 +43,3 @@ If you are on `main`, with no local changes, run `scripts/deploy.sh`.
2643

2744
Run `scripts/docker.sh`: This will build and start a new image.
2845
Confirm that it works, and then follow the instructions in the output to push to Docker Hub.
29-
30-
## Conventions
31-
32-
Branch names should be of the form `NNNN-short-description`, where `NNNN` is the issue number being addressed.
33-
34-
Add developer-only dependencies in `requirements-dev.in`; Add other dependencies in `requirements.in`. After an edit to either file run `scripts/requirements.py` to install the new dependency locally and update `pyproject.toml`.
35-
36-
A GitHub [project board](https://github.com/orgs/opendp/projects/10/views/2) provides an overview of the issues and PRs.
37-
When PRs are [Ready for Review](https://github.com/orgs/opendp/projects/10/views/2?filterQuery=status%3A%22Ready+for+Review%22) they should be flagged as such so reviewers can find them.
38-
39-
```mermaid
40-
graph TD
41-
subgraph Pending
42-
%% We only get one auto-add workflow with the free plan.
43-
%% https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically
44-
Issue-New
45-
PR-New-or-Changes
46-
end
47-
%% subgraph In Progress
48-
%% How should this be used?
49-
%% Can it be automated
50-
%% end
51-
subgraph Ready for Review
52-
PR-for-Review
53-
end
54-
subgraph In Review
55-
PR-in-Review --> PR-Approved
56-
end
57-
subgraph Done
58-
Issue-Closed
59-
PR-Merged
60-
PR-Closed
61-
end
62-
PR-New-or-Changes -->|manual| PR-for-Review
63-
PR-for-Review -->|manual| PR-in-Review
64-
Issue-New -->|auto| Issue-Closed
65-
PR-New-or-Changes -->|auto| PR-Closed
66-
PR-for-Review -->|auto| PR-Closed
67-
PR-in-Review -->|auto| PR-Closed
68-
PR-for-Review -->|manual| PR-New-or-Changes
69-
PR-in-Review -->|auto| PR-New-or-Changes
70-
PR-Approved -->|auto| PR-Merged
71-
```
72-
- For `manual` transitions, the status of the issue or PR will need to be updated by hand, either on the issue, or by dragging between columns on the board.
73-
- For `auto` transitions, some other action (for example, approving a PR) should trigger a [workflow](https://github.com/orgs/opendp/projects/10/workflows).
74-
- These are the only states that matter. Whether PR is a draft or has assignees does not matter.
75-
- If we need anything more than this, we should consider a paid plan, so that we have access to more workflows.

0 commit comments

Comments
 (0)