Open Source Checklist

This serves as a rough guideline for software projects that we will release as open-source. We don’t need to fulfill every single requirement for the Initial Release, but we should constantly update the fields as our project grows.

Documentation

Did we provide a README.md with basic information and setup on the project?
Did we provide an API documentation for the project?
Do we have a contributing guide in CONTRIBUTING.md?
Do we have a CHANGELOG.md to document our releases?
Do we have an OSI-approved LICENSE?

Code

Does our code follow the community style guide for our language of choice?
Did we set-up automated testing for our business-logic code?
Did we set-up continuous-integration/continuous-deployment (CI/CD) for the project?
Do we follow semantic versioning guidelines?
(Optional) Do we enforce style checks in our codebase?
(Optional) Did we make our project accessible via package managers? (pip, npm, etc.)