Skip to content

Commit

Permalink
feat: #201 #292 add documentation about PR guidance and codeowners
Browse files Browse the repository at this point in the history
  • Loading branch information
Zelos Zhu committed Jul 26, 2023
1 parent 1515b1b commit 4fbd071
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions vignettes/pr_review_guidance.Rmd
Expand Up @@ -53,6 +53,12 @@ For a pull request to be merged into `devel` it needs to pass the automated CI c

- all files affected by the implemented changes, e.g. vignettes and templates, are updated

## Codeowners and PR Guidance

As the creator of a PR, the assignment of a reviewer can be unclear. For most PRs, feel free to select a few members of the core development team. These individuals scan each repository on a regular basis as well and may provide his/her review even if not originally included as a selected reviewer.

Sometimes, the development of a function or a vignette falls under a specific-topic, e.g. labs or PK/PD. Please ensure you include an appropriate reviewer if you are modifying files that rely on domain-expertise. We try to maintain an active list for domain-specific topics that will automatically tag an appropriate reviewer using our `CODEOWNERS` file, located in the `.github` folder. If you are interested in being a codeowner, reach out to the development team.

# So much Red Tape!

The `{admiral}` development team is aware and sympathetic to the great many checks, processes and documents needed to work through in order to do a compliant Pull Request. The `task-list-completed` GitHub workflow was created to help reduce this burden on contributors by providing a standardized checklist that compiles information from the Pull Request Review Guidance, [Programming Strategy](programming_strategy.html) and [Development Process](development_process.html) vignettes.
Expand Down

0 comments on commit 4fbd071

Please sign in to comment.