Welcome contributors
Requirements
The codebase MUST allow anyone to submit suggestions for changes to the codebase.
Examples
- GitHub pull requests like https://github.com/publiccodenet/standard/pulls
- Self-hosted Gitea pull requests
- (add a good gitlab example)
The codebase MUST include contribution guidelines explaining what kinds of contributions are welcome and how contributors can get involved, for example in a CONTRIBUTING file.
Resources
Examples
- OpenZaak CONTRIBUTING
- OpenGovernment CONTRIBUTING
- Git CodingGuidelines is an example of a mature codebase with extensive guidelines
- Template for gemeente Amsterdam
The codebase MUST document the governance of the codebase, contributions and its community, for example in a GOVERNANCE file.
Examples
- OpenRefine GOVERNANCE, example of a fairly mature governance structure
Tools
- Simple template for GOVERNANCE file
- The Governance game is a tool that help communities explore their needs of governance.
- CommunityRule is a governance toolkit to create governance files based on templates of common types of governance.
Further reading
- The Good Governance Initiative by the OSPO Alliance has a handbook for building governance.
- Best Practices for the Governance of Digital Public Goods by the Ash Center for Democratic Governance and Innovation contains a playbook of different pracitces to implement in the governance along with case studies.
- Organization & Structure of Open Source Software Development Initiatives by Cyberlaw Clinic has a good overview of different governance models.
- Governance of open source software: state of the art is an academic article on governance and might be useful for someone that needs solid arguments for their decisions.
- IEEE Open Source Maintainers Manual by the Institute of Electrical and Electronics Engineers can provide some inspiration as it provides the policies, guidelines, advice, and requirements for project leads, maintainers, contributors and other participants involved in IEEE Open Source projects.
The contribution guidelines SHOULD document who is expected to cover the costs of reviewing contributions.
The codebase SHOULD advertise the committed engagement of involved organizations in the development and maintenance.
Examples
- OS2 Rollekatalog (in Danish)
- CKAN (see the footer)
- MasterPortal
The codebase SHOULD have a publicly available roadmap.
This could also be solved by having public task boards/kanban boards with suitable columns and issues/stories at high level (sometimes called Epics).
Examples
The codebase SHOULD publish codebase activity statistics.
Examples
Including a code of conduct for contributors in the codebase is OPTIONAL.
Examples
- Contributor Covenant Code of Conduct is a code of conduct with a set of core values and norms that are essential in a just and equitable software commons. It can be adapted to include the special shared values and norms particular to your own community and its members.