Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 1.65 KB

starting_open_source_project.md

File metadata and controls

33 lines (17 loc) · 1.65 KB

Starting an Open Source Project

This document provides some quick pointers as you plan to make your work publicly available under and Open Source license.

How to start an Open Source project: Best Practices

GitHub's opensource.guide provides an easy to follow checklist to help you if you want to open source your project:

Documentation

✔ GitHub repository - the WHO has adopted GitHub as the standard code repository for software projects

✔ License - add a LICENSE file containing your chosen open source license to your project

✔ Basic documentation - add README, CONTRIBUTING, and CODE_OF_CONDUCT files to guide people who want to know more about the project and perhaps contribute to it

Code

✔ Conventions and best practices - use consistent code conventions and practices to make your work easily maintainable

✔ Continuous documentation - add code comments or inline documentation

💡 Hint: If you wanted to contribute to an open source project, what practices would make it easier for you? Apply the same to encourage your community to contribute to your work.

Community and Collaboration

✔ Promote your project internally and externally

✔ Assign a community manager to handle interaction with your community

💬 How the Open Source Programme Office Can Support Your Work

If you have questions, would like to make an existing project open source, or start a new project that you would like to be open source, please reach out on Discussions.