Standard for Public Code

目次

  1. Requirements
  2. Why this is important
  3. What this does not do
  4. How to test
  5. Policy makers: what you need to do
  6. Management: what you need to do
  7. Developers and designers: what you need to do
  8. Further reading

到 GitHub 貢獻

Welcome contributors

Requirements

  • The codebase MUST allow anyone to submit suggestions for changes to the codebase.
  • 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.
  • The codebase MUST document the governance of the codebase, contributions and its community, for example in a GOVERNANCE file.
  • The codebase SHOULD advertise the committed engagement of involved organizations in the development and maintenance.
  • The codebase SHOULD have a publicly available roadmap.
  • The codebase SHOULD publish codebase activity statistics.
  • Including a code of conduct for contributors in the codebase is OPTIONAL.

Why this is important

  • Helps newcomers understand and trust the codebase community’s leadership.
  • Prevents the community that works on a codebase splitting because there is no way to influence its goals and progress, resulting in diverging communities.
  • Helps users decide to use one codebase over another.

What this does not do

  • Guarantee others will join the community.
  • Guarantee others will reuse the codebase.

How to test

  • Confirm that it is possible to submit suggestions for changes to the codebase.
  • Confirm there are contribution guidelines.
  • Confirm that the codebase governance is clearly explained, including how to influence codebase governance.
  • Check for a list of involved organizations.
  • Check for a roadmap.
  • Check for published activity statistics.
  • Check for a code of conduct.

Policy makers: what you need to do

  • Add a list to the codebase of any other resources that policy experts, non-governmental organizations and academics would find useful for understanding or reusing your policy.
  • Consider adding contact details so that other policy makers considering collaboration can ask you for advice.

Management: what you need to do

  • Make sure that the documentation of the governance includes the current process for how to make changes to the governance.
  • If the community has some consensus about how the governance should change, then include those ideas stated as ambitions in the documentation.
  • Make sure the documentation explains how each organization is involved in the codebase, what resources it has available for it and for how long.
  • Support your experienced policy makers, developers and designers to stay part of the community for as long as possible.

Developers and designers: what you need to do

  • Respond promptly to requests.
  • Keep your management informed of the time and resources you require to support other contributors.

Further reading