⚜️Open Sourcing Your Project

This is a support document to help projects understand how they can make their solutions open source

You can refer to these resources for a more in-depth approach on how to open source your project:

📌 Starting an Open Source Project

📌 DPGAlliance/DPG-Standard: Digital Public Goods Standard

✅ Checklist

A good open source project can check off all of these boxes under different tabs of Documentation, Coding, and People.

Docs

Documentation Checklist

• Project has a licence file with an open source licence

• Project has basic documentation (readme, contributing guidelines, code of conduct)

• Link to your Contributing + Code of conduct file from your Readme

• 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 organised and labelled

Code

Code checklist

• 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

People checklist

• 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