Skip to content

Document automated PR reviewer checklist workflow #30

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

Closed
wants to merge 1 commit into from
Closed

Document automated PR reviewer checklist workflow #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Example:
### 5 - Zenodo with [CFF file](https://github.com/physiopy/physiopy-automations/blob/master/CITATION.cff)
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.

### 6 - [reviewer.yml](https://github.com/physiopy/physiopy-automations/blob/master/.github/workflows/reviewer.yml) for automated checklists
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).


## Contributors ✨

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!
Expand Down