Skip to content

Commit f1036fc

Browse files
authored
Document automated checklist for PR reviewers
Added section about automated PR reviewer checklists.
1 parent 0250f6b commit f1036fc

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ Example:
4040
### 5 - Zenodo with [CFF file](https://github.com/physiopy/physiopy-automations/blob/master/CITATION.cff)
4141
We use the third-party data archiving tool Zenodo to create a DOI that can be used for archiving and citing content. To set-up Zenodo on this GitHub we followed [these steps](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content). Every time a new release is created, a new DOI will be issued and the [Zenodo page](https://zenodo.org/records/14753284) will be automatically updated. See the badge at the top of this README, that visitors can easily click on to reach this Zenodo page. Zenodo makes some guesses based on repo information, to populate title and authors etc. However, it is better to define this in the [CFF file](https://github.com/physiopy/physiopy-automations/blob/master/CITATION.cff) so Zenodo reports this accurately and in the way we would like.
4242

43+
### 6 - [reviewer.yml](https://github.com/physiopy/physiopy-automations/blob/master/.github/workflows/reviewer.yml) for automated checklists
44+
This workflow tries to make it easier for PR reviewers to remember what tasks they are responsible for, and where to look for guidance. After the first reviewer is assigned to the PR, a comment will be automatically generated in the PR thread tagging this reviewer as the main reviewer and displaying [main_rev_checklist.md](https://github.com/physiopy/physiopy-automations/blob/master/.github/workflows/main_rev_checklist.md). All reviewers that are added after will have a comment automatically generated in the PR thread tagging them and displaying a different checklist [rev_checklist.md](https://github.com/physiopy/physiopy-automations/blob/master/.github/workflows/rev_checklist.md).
45+
4346
## Contributors ✨
4447

4548
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification([emoji key](https://allcontributors.org/docs/en/emoji-key)). Contributions of any kind welcome!

0 commit comments

Comments
 (0)