IndieWeb GitHub organization
This article is a stub. You can help the IndieWeb wiki by expanding it with relevant information.
IndieWeb GitHub organization is a GitHub organization setup for community developed and maintained projects that are of high enough quality for new developers to discover and quickly start using to improve their personal sites, CMS, or Get Started developing personal site software.
Brainstorming
Best practice recommendations for active projects
We should capture recommendations for how projects under the GitHub org are managed so that they stay maintained.
- A clear readme
- Title
- Badges in the readme indicating CI status
- Basic documentation
- Contact info
- Multiple maintainers
- A CONTRIBUTING.md file
- Add a code owners file to indicate who the maintainers are and automatically assign them to review PRs
- Unit tests
- A changelog (either a separate file or GitHub releases)
- Use semantic versioning for releases
- Compatible with latest version of programming language and framework
- Be reviewed annually for active maintenance
Qualifications for inclusion
- IndieWeb relevance
- Some threshold of importance
- Used by the community (not just one person)
- An active maintainer
- Projects should be stable (greater than v1.0.0)
Compare with Microformats org
- Are there any differences in how the github orgs are managed?
- Should any recommendations and practices apply to both orgs?
- Should the microformats org also have a wiki page?