Checklist
Open-Source Release Checklist
A practical checklist before publishing code, data, models, or experiment scripts.
Before release
- Confirm that the artifact can be publicly shared under the intended license.
- Remove credentials, private paths, unpublished reviewer comments, and institution-only data.
- Add a README with installation, usage, citation, and contact information.
Minimum package
- Provide environment files such as requirements.txt, environment.yml, Dockerfile, or scripts.
- Include a tiny example that finishes quickly and verifies the main pipeline.
- Document expected inputs, outputs, hardware assumptions, and runtime.