Introduction Link to heading
I’m excited to announce the release of my latest Hacktoberfest project: Readme Auto Open.
You can find the source code on GitHub and the extension in the Visual Studio Code Marketplace. Give it a try, and let me know what you think by leaving a rating!
What is Readme Auto Open? Link to heading
I’ve found that one of the biggest challenges when onboarding new team members is getting them up to speed with the project. One of the best ways to do this is by having a well-documented README file. However, I’ve found that developers don’t often read these files. Most often this is because the quality of the README of related projects file is not great, but sometimes it’s just because they forget to open it, or if it isn’t easily accessible in their editor of choice.
That’s why I created Readme Auto Open. This extension automatically opens the README file when you open a project in Visual Studio Code. This way, you can’t forget to read it, and it’s always easily accessible.
By making developers more aware of the README file, I hope to make it easier for them to get up to speed with the project. I hope that this causes another side-effect of making developers more aware of the importance of good documentation, increasing the quality of README files in general and making it easier for developers to get up to speed with new projects!
Questions? Ideas? Feedback? Link to heading
Let me know in the comments below, on the marketplace or on the GitHub repository!