silverstripe / silverstripe/developer-docs
Review contribution Maintainer Guideline following the initial onboarding first crop of maintainers
Open
Nobody has claimed this yet.
type/other
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
In https://github.com/silverstripe/.github/issues/142, we added documentation to make sure new community maintainer could properly understand how to contribute. This was drafted with the expectation that we would iterate over it.
Acceptance criteria
- All redundant INFO blocks are removed.
- Feedback from the initial crop of community maintainers is sought.
- Guidelines are updated accordingly
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with 06_Project_Governance/03_Maintainer_Guidelines.md and review the related issue #142, focusing on the INFO blocks and the guidance added for community maintainers. Seek feedback from the initial group of maintainers, then update the guidelines to address it; done means redundant INFO blocks are removed and all acceptance criteria are met.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100