Skip to content

Conversation

@Arielle-Bennett
Copy link
Contributor

Dan Sholler from Organizational Mycology has written up a very comprehensive checklist for Team Compass Maintenance, with a suggested quarterly review cycle: https://docs.google.com/document/d/1NcTDX2a06gZ-ayIrqKeV_EebrDE4icx3pjiSowgi7cI/edit?tab=t.0#heading=h.5h8wk7irgfoo

I wanted to enhance the project's documentation practices so I've borrowed a GitHub action and turned the checklist into an issue template which will open automatically on a quarterly basis. It can also be run manually.

Note that there's a lot of parts to the checklist - it's not expected that only one person would take this on! But this checklist could also be split up explicitly into different issues if people think that would make it more attractive for someone to tackle each section.

  • Do the checklists in the issue template cover what we would like to include in a review of the team compass documentation?
  • Does the action do what we expect it to? Are there any problems you foresee with it?
  • Should we keep the checklist as is, or split into different issues to avoid contributor overwhelm?
  • Do we need to enhance the checklist e.g. by adding direct links etc? (This makes it easier for the person doing the checklist but much harder to maintain, speaking from experience)
  • Anything else?
  • Dan has written some great text about the importance of doing this work - this is not included in the issue template for now but where should it be incorporated?

Updated the issue template for the Team Compass Review, adding detailed checklists and questions for various aspects of team governance, meetings, resources, practices, project goals, onboarding, content review, and meta-documentation.
Expanded the description and importance of the Team Compass Review issue template.
Added labels and assignees to the Team Compass Review Checklist template.
Updated label formatting in the issue template.
@Arielle-Bennett Arielle-Bennett marked this pull request as ready for review November 6, 2025 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant