Session 8 - example
Community Manager Overview Documentation
The notes here were gathered during a 1 hour video tour through the Open Terms Archive project
Open Terms Archive
Links
- GitHub: https://github.com/OpenTermsArchive
- Website: https://opentermsarchive.org (driven by https://github.com/OpenTermsArchive/docs)
A Day in the life of the Community Manager
Review & Merge Pull Requests
Review additions or changes (mostly driven by internal bots) to the Archive
Review additions or changes (mostly driven by internal bots) to the Archive by using the review function in GitHub PRs and then Merging the PR once confirmed valid
- OTA has a graphical interface for reviewing the content in the PR
- CMs will need to understand how to do a PR review in GitHub
- GitHub help file: Reviewing proposed changes in a pull request
- CMs will need to understand how to Merge a PR once reviewed (using Squash and Merge)
- GitHub help file: Merging a pull request
- Example of Open PRs for Updating: Issues tab, with filters (is:pr is:open update)
- Example of Closed PR: https://github.com/OpenTermsArchive/contrib-declarations/pull/871
New Contributor Onboarding
Identify which contributors are already onboarded and which need onboarding Review the new issues in the Engine or other repositories.
- Outside contributors will create issues. These issues need to be reviewed for
- Clarity: Do we know what the author is talking about?
- Details: Are there enough details that a contributor, besides the author, could work on it?
- Relevance: Is this a change that will be accepted into the code base?
- Other?
- When responding to the author it is important to
- keep communication professional and friendly to encourage community engagement.
- be familiar with the contributing guidelines so that you can make sure the Issues conform to guidelines.
- Example Issues can be found here: https://github.com/OpenTermsArchive/engine/issues
Discussions
Join the discussion if you are qualified
- Review the open discussions
- Identify if you are qualified to participate in the discussion
- If you are qualified, answer the question
- If you are not qualified to answer the questions, you don’t need to do anything, someone else on the team will see the activity and respond
- Example: https://github.com/OpenTermsArchive/terms-types/discussions/13
Technical Documentation
Edit the documentation (to be more user friendly), if you are qualified
- Example: https://docs.opentermsarchive.org/
Create A Guide to being the Community Manager
Take the instructions given you, both written and verbal, turning it into documentation for the next or other Community Managers. This document is a good starting point.
Awareness of Jurisdiction
Different countries have different terms for the same things.