reviewchecklist.yml

name: Review Checklist

on:
  pull_request_target:
    types: [review_requested]

jobs:
  review-checklist:
    name: Review Checklist
    runs-on: ubuntu-latest
    steps:
      - uses: actions/github-script@v6
        with:
          script: |
            const { data: comments } = await github.rest.issues.listComments({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
            });

            // if comment already exists, then just return
            if (comments.find(comment => comment.body.includes("### Review Checklist"))) { return; }

            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: `### Review Checklist

            Does this PR follow the [development guidelines](https://algebraicjulia.github.io/Catlab.jl/dev/devdocs/style/)? Following is a *partial* checklist:

            **Tests**

            - [ ] New features and bug fixes have unit tests
            - [ ] New modules have tests that are ultimately called by the test runner (\`test/runtests.jl\`)
            - [ ] Existing tests have not been deleted
            - [ ] Code coverage >= 90% or reduction justified in PR

            **Documentation**

            - [ ] All exported functions, types, and constants have docstrings, written in complete sentences
            - [ ] Citations are given for any constructions, algorithms, or code drawn from external sources

            **Other**

            - [ ] Style guidelines are followed, including indent width 2
            - [ ] Changes breaking backwards compatibility have been approved`,
            })