This content originally appeared on DEV Community and was authored by Rizel Scarlett
Hacktober is over, but that doesn't mean we shouldn't continue to encourage folks to contribute to open source. One of the ways maintainers can attract more long-term contributors is by writing a great README. I've done some research and compiled a list of tips for you to create a README that will attract contributors to your community.
Why should I create a README?
Creating a README for your personal profile and your organization is fun and essential. However, writing an excellent README for your open source project's repository is of equal importance. Your README provides new users and potential contributors with the first impression of your project. To be clear, while your Contributing.md enables contributors to make and merge pull requests in your repo, your README guides users on how to use your project.
What should I write in my README?
Start by adding the title for your project
This example is sourced from Open Sauced
Add a few short statements describing why your project exists and what it does
This example is sourced from Slinkity
Inform users on how to install and use your project
This example is sourced from Timber
Let users how they can get help
This example is sourced from RasaHQ
Include links to essential documentionation
This example is sourced from CodeNameOne
Show off your contributors
This example is sourced from use-shopping-cart
Add a link to your project's license
This example is sourced from RasaHQ
Go the extra mile by adding:
- A Table of Contents
- The project's tech stack and features
- A link to your production instance
- A screenshot of the project's user interface
- Dependencies
- Known issues
I need help making it look pretty!
Try using Readme.so, an open source project built by Katherine Peterson makes it easy to build and customize all the sections of your README.
You can also use this template provided by the Consumer Financial Protection Bureau.
Comment below with a project's README that you love or a README you created!
This content originally appeared on DEV Community and was authored by Rizel Scarlett
Rizel Scarlett | Sciencx (2021-11-02T19:31:24+00:00) How to Create the Perfect README for Your Open Source Project. Retrieved from https://www.scien.cx/2021/11/02/how-to-create-the-perfect-readme-for-your-open-source-project/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.