Skip to content

Commit

Permalink
Update rules/use-readme-templates/rule.md
Browse files Browse the repository at this point in the history
Co-authored-by: Matt Wicks [SSW] <wicksipedia@users.noreply.github.com>
  • Loading branch information
Calinator444 and wicksipedia authored Feb 7, 2025
1 parent 0069f2e commit f8b4e41
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions rules/use-readme-templates/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ It's important to keep your README templates in a convenient place to ensure tha

## What does an awesome README template look like?

The ideal README should foster contributions for a project organically. It should provide all the relevant information a contributor user would need to get the project up and
running, make code changes, and deploy to production if necessary. It should also contain a number of clearly located social media links so followers of the project
users can keep an ear to the ground for updates. Followers who see regular updates via social media are more likely to feel actively involved and will commit to the project's success.
The ideal README should foster contributions for a project organically. It should provide all the relevant information a contributor user would need to get the project up and running, make code changes, and deploy to production if necessary. It should also contain a number of clearly located social media links so followers of the project users can keep an ear to the ground for updates. Followers who see regular updates via social media are more likely to feel actively involved and will commit to the project's success.

We've created a README template with placeholders where you can add all of the relevant information for your project to ensure that it's a success. Bear in mind that not all of the information listed will be relevant to your particular project. For instance, closed-source projects more than likely won't contain social media or sponsorship links. Feel free to remove any placeholders that aren't relevant to your project.

Expand Down

0 comments on commit f8b4e41

Please sign in to comment.