🤵 by Karan Goel (kgoel [at] cs.stanford.edu) | twitter: @krandiash

Who is this for?

• Limited prior software development experience.
• Never open-sourced a project before.
• AI researchers who want their project used and contributed to.

What to expect?

A minimal list of ingredients to create a well-managed open-source Python project.

• This will help if you have no idea how to go from research code → open-source project.
• Ingredients are non-exhaustive.
• This is not a walkthrough. Expect to Google (but you'll know what to Google).
• Use at your own risk.

The ingredients in no particular order

1. Code Organization

   Code Organization

2. Makefile

   Makefile

3. Dependencies & Environments

   Dependencies & Environments

4. Unit Testing

   Unit Testing