DEV Community

Discussion on: Preparing your project being open sourced

Collapse
 
notsag profile image
Maxime Gaston

Nice post, this is definitely mandatory for anyone to be able to contribute to your open source project.

I would also add the following steps :

  • use a proper logging system (not just print/echo)
  • have at least basic local tests and static code analysis to ensure a minimal level of quality
  • have issue templates to be ready to receive feature ideas or bug reports
  • have a basic documentation (or at least docstrings in the code and a plan to generate documentation)
  • setup continuous integration (using Travis, Azure pipelines, Actions...)
Collapse
 
yvonnickfrin profile image
🦁 Yvonnick FRIN • Edited

Thank you Maxime! Sure I planned to write an article about how to maintain an open source project with all these topics in it. This one was more beginner oriented. In my opinion it was two separate subjects, what do you think of it?

Collapse
 
notsag profile image
Maxime Gaston

Step-by-step is a good idea 😉