DEV Community

Cover image for Preparing your project being open sourced

Preparing your project being open sourced

🦁 Yvonnick FRIN on August 28, 2019

In a previous article, we helped you submit your first contribution. You now want to launch your own open source project but you don't know what to...
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 πŸ˜‰

Collapse
 
louckousse profile image
louckousse

For someone who mark react as one of his/her skill you seem to have missed what happened 3 days ago about code of conduct. The politically correct is a rhetoric only used by people who doesn't want to question their conduct and doesn't care about others.

I'm really sad to see people still using that kind of argument and against code of conduct.

Collapse
 
daviddalbusco profile image
David Dal Busco

Regarding the license, furthermore than adding a LICENSE file to the project I think it's common, correct my if I'm wrong, to add also a last chapter about it in the README

Collapse
 
yvonnickfrin profile image
🦁 Yvonnick FRIN • Edited

Sure, that's a good point, thank you! You can see this kind of section in this readme template from makeareadme.com.

Collapse
 
daviddalbusco profile image
David Dal Busco

Cool πŸ‘

Collapse
 
ben profile image
Ben Halpern

Nice post, very well done.

Collapse
 
yvonnickfrin profile image
🦁 Yvonnick FRIN

Glad to read you liked it. Thank you!

Collapse
 
elvinaqa profile image
Elvin Aghammadzada

great