Skip to content

Latest commit

 

History

History
85 lines (41 loc) · 3.38 KB

opensource-checklist.md

File metadata and controls

85 lines (41 loc) · 3.38 KB

The Open Source release checklist

Make SURE that

  • there exists a README file that describes the project

  • there exists a LICENSE file containing an OSI approved license

  • the license of the project is not in conflict with the license of the project dependencies

    • Don't forget to check the licenses and terms of usage for any resources that are not code - ensure that all images and such are distributable and that you have given credit in the proper way and in accordance with the resources' license. Hint: see the Reuse software further down this list.
  • there are no sensitive data, passwords etc, leaked in the commit history or elsewhere

    • There are many tools for auditing commits and git repositories.
    • Example: gitleaks or trufflehog
  • there are no identical or similar known registered trademarks with your project name.

    • Do a sanity Google control check, and if you are unsure, a trademark search.

    • Example: You have a project called Orakel DA, but, there is the globally known trademark Oracle DB. Change your name from Orakel DA to something else.

      However, It might be ok to use a name that is reminiscent of an existing trademark, if the existing trademark is used for other services/areas and is not recognized as a known trademark, as in the following example.

    • Example: You a have project called Encore Linux, but there already exists a registered trademark for a bicycle repair company called Encore Bicycle AB. You might be able to release your project without name changes.

Mandatory for code-based projects unless the project is clearly marked as being in an early development stage

  • Make sure security vulnerabilities have been remediated

  • Do a code review

Recommended

Optional

  • Describing dependencies in the README

  • Generating API docs, if applicable

  • Having unit tests

  • Having clean source code comments

  • Having a build pipeline on GitHub or other CI-tool of choice

  • Including a screenshot in the README

  • Add a few relevant GitHub Badges to your README

    • Example: See this project README for license, version and Reuse badge examples.