README file is one of the most important parts of your project. It represents your code or the whole project in a short and more descriptive way.
Why do we have a README file?
A README helps you to remember how was the process of your project. For example, when you try to check a project that is done before 2 years, your README file will guide you to your own project. If you did some specific way and you described it in your README file, it is easy to remember. You will not spend hours reading your code. It helps to avoid confusion.
In another way, a README file is like a communication tool between other developers. Developers can understand the flow of your work easily. Developers know overall of the project before they check your code. It helps you to collaborate easily with your team.
What should you write in your README file?
The README file is not for the code part. It is a useful tool for description/collaboration on your project. Think about how to describe your project and you can put tables, lists …etc but there are things you should not forget in your README file.
1. Title: good title or name of the project.
2. A short description of your project: describe your project or your idea. For example, as a developer what is your aim in this project, or what kind of problem do you need to solve?
3. Change log: at this time frameworks and tools have updated quickly, so your project which is done before 2 years may be needs some updates. So you need to mention the version of the technologies you used.
4. Technologies and tools you used: It will help to others if you mention the tools and technologies you used.
5. Collaborators: Give credit to your team. mention them as collaborators and their position. for example, “Feruz: Collaborate as a front-end developer and merry: Collaborate as a back-end developer”
6. How to run your project: The person who needs to see the project may use a different language from you used or he is a beginner. It is helpful and important if you help them how to run the project on their local machine.
7. Workflow: Workflow has some credit in your project. How do you collaborate, and how divide your tasks or daily tasks…etc. Maybe it is not important to explain detail in your README file, but you can put a link to show the workflow, for example, your GitHub project. On another hand, you can mention only things which you think it is important.
8. Incomplete part of your project: Do you have an incomplete part? Just mention it in your README file. Maybe someone has an idea or time to help you. That can open the door to discussing or collaborating with others.
Conclusion
Good README is an image of your project. If you are a beginner like me just use templates and learn how to write a good README. Do you need to add something? write it in the comment.
Template how to write good README
https://github.com/othneildrew/Best-README-Template
Thank you for Reading!
