top of page

Documentation

Project has a LICENSE file with an open source license

Project has basic documentation (README, CONTRIBUTING, CODE_OF_CONDUCT)

The name is easy to remember, gives some idea of what the project does, and does not conflict with an existing project or infringe on trademarks

The issue queue is up-to-date, with issues clearly organized and labeled

Code

★ Be demand driven

  • Are your choices about the data you release, how it is structured, and the tools and support provided around it based on community needs and demands?

  • Have you got ways of listening to people’s requests for data, and responding with open data?

★ ★ Put data in context

  • Do you provide clear information to describe that data you provide, including information about frequency of updates, data formats and data quality?

  • Do you include qualitative information alongside datasets such as details of how the data was created, or manuals for working with the data?

  • Do you link from data catalogue pages to analysis of the data that your organisation, or third-parties, have already carried out with it, or to third-party tools for working with the data?

★ ★ ★ Support conversation around data

Project uses consistent code conventions and clear function/method/variable names

The code is clearly commented, documenting intentions and edge cases

There are no sensitive materials in the revision history, issues, or pull requests (for example, passwords or other non-public information)

People

If you’re an individual:

You've talked to the legal department and/or understand the IP and open source policies of your company (if you're an employee somewhere)

If you’re a company or organization:

You've talked to your legal department

You have a marketing plan for announcing and promoting the project

Someone is committed to managing community interactions (responding to issues, reviewing and merging pull requests)

At least two people have administrative access to the project

bottom of page