Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
[Good first PR] Add READMEs to undocumented plugins #7175
Thank you to everyone who participated! You're free to continue on the quest to document all the plugins!
For some time we've had it in our minds to add a README to every plugin, as a way of documenting what the plugin does and what it requires, among other things. We have some READMEs already but most plugins lack one. That's why this issue exists, so you can take part in this effort.
The README should follow a very simple structure:
You'll need to read the
If you want to work on the README for one of the following plugins, comment below and I'll mark it as such.
Thanks for your contribution and happy Hacktoberfest!
While having a template is great for most plugins, some doesn't even have any requirements or even configurations. Maybe if there's some kind of directory containing various readme templates for different kind of plugins, that'd be great.
Speaking of readmes, I have submitted a pull request about creating the readme for the
Reserved. You can create the READMEs from the github web interface. For example, you'd navigate to the chucknorris folder and create a new file named
Then you commit it (make sure to preview first to check that it looks nice), and afterwards it'll give you the option of creating a pull request.
If you have made it using git, then this guide has a pretty comprehensive view of the steps you need to follow.