📝Steps to take before starting a new Open-source project.📝

In this blog, we will see some good practices which you can include in your next open source project.

🔖 License Agreement:

It is said that if your project does not consist of a License agreement then it is not an open-source project but it is a free source project. So it is always good practice to add one to your project. You can add either of the pre-made licenses or add a custom license.

🔖 Readme.md:

It is obvious that you know your project very well and knows how to run it on the local system. But, this is not the case with other people who want to contribute/use your project. It is best practice to add a readme file in your project which includes the following:

About project
Project tags (https://shield.io/)
Screenshot / GIF of working project
Pre-requisites
Instructions for new contributors
How to set up a local environment
Any additional instruction
Recognition to contributors/ sponsors

🔖 Contributing.md:

This is an important file and acts as a manual for new contributors to your project. It may contain the following things

Pre-requisites
Instructions for new contributors
How to set up a local environment

🔖 CODE_OF_CONDUCT.md:

This is a most undervalued file. The name of the file is self-explanatory. This file contains the rules and regulations one needs to follow while contributing to the project and interacting with other contributors to the project.

🔖 Issue & PR Template:

There is yet another important file you should include in your project. This files basically ensures that the raise issue/PR gives the information to the point and creates equilibrium between other issues/PR

🔖 GitHub Actions:

This is optional. But, if you add an action to your project. You can take your project to another level. These actions are basically triggers that initiate after a particular task. For example, you can add an action that congratulates the contributor after raising an issue/PR.

Thank you so much for reading

Catch me on my socials: https://bio.link/kaiwalya

📝Steps to take before starting a new Open-source project.📝

Comments

More from this blog

Getting started with Observability using SigNoz 🔭

Building pod-logger from scratch

How I cleared my Kubernetes and Cloud Native Associate (KCNA) exam in first attempt.

Application Logging with FluentD

Dark Side of DevRel: Moving beyond the sterotypes

🔖 License Agreement:

🔖 Readme.md:

🔖 Contributing.md:

🔖 CODE_OF_CONDUCT.md:

🔖 Issue & PR Template:

🔖 GitHub Actions:

Thank you so much for reading

Command Palette

Comments

More from this blog

🔖 License Agreement:

🔖 Readme.md:

🔖 Contributing.md:

🔖 CODE_OF_CONDUCT.md:

🔖 Issue & PR Template:

🔖 GitHub Actions:

Thank you so much for reading