Comments (2)
I don't think that requiring +1s in PRs or disabling self-sumbissions would necessarily be a net positive. The former would make PRs stale if nobody else is paying attention, which is unfair; and the latter provides no hard guarantee of quality: there is of course a correlation with a third-party having evaluated one's documentation and deemed it good, rather than self-evaluation which is naturally biased; but the reverse relationship does not hold (a self-submitted entry can still be a great readme).
As for adding explanations for each entry, that's a good thing IMO and is closer to a solution for this issue; but IIUC that is already the case, right?
IMO the best way to address the core problem is to collaboratively define a set of guidelines that a good readme should follow (something similar to the standard readme spec, but focused on nice extras rather than basic requirements) so that submissions have a concrete set of boxes to tick.
Some of the things I'd consider marks of a good readme:
- title and short description of the project
- badges (build status, maintenance status, issue stats, etc.)
- table of contents if there are more than, say, 3 sections
- installation and usage instructions, with copy-pastable commands
- dependencies / prerequisites
- contribution guidelines
- birds-eye overview of the project (what files exist, how they are organized, what each one does, how they relate to each other...)
- bonus points if presented in a systematic form, like a table
- bonus points if presented in a visual form, like a graph or diagram
- screenshot (static or animated) of the project in action
And likely others I'm overlooking right now.
from awesome-readme.
I think one important aspect of READMEs is that they are easily readable in a text editor without rendering.
Though, if you check this out from the list https://raw.githubusercontent.com/ma-shamshiri/Spam-Detector/master/README.md I'd say it's more an HTML file than a README.
from awesome-readme.
Related Issues (20)
- Add `readme.so` to the Tools section HOT 2
- Is this still maintained? HOT 2
- Maintainers and collaborators? HOT 6
- The Travis Build Fails HOT 1
- Request to add README HOT 2
- Request to add readme of NASA Ogma HOT 1
- Awesome HOT 1
- Analyze my readme HOT 2
- rayhanadev/rayhanadev link dead HOT 2
- AndrOBD readme suggestion HOT 1
- Feedback Demo 1 HOT 1
- Global-Chem README HOT 1
- sidid HOT 1
- Request to list Yampa's README HOT 2
- Request to add a Readme HOT 1
- Categorize examples by ecosystems HOT 9
- We HOT 1
- Include quality ARCHITECTURE and CONTRIBUTING documentation HOT 4
- Awesome Readme - Website HOT 1
- Please consider adding my profile HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from awesome-readme.