Check all the README files
--------------------------
Key: NXP-6289
URL: https://jira.nuxeo.com/browse/NXP-6289
Project: Nuxeo Enterprise Platform
Issue Type: Clean up
Reporter: Stéfane Fermigier
Fix For: 5.4.1
See
http://thechangelog.com/post/3032074343/top-ten-reasons-why-i-wont-use-your-open-source-project
for a checklist.
"For a lot of projects, especially those hosted on GitHub, the Readme is often
the first look someone has at your project. Tom Preston-Warner says the Readme
is so important that you should write it first. I've started doing this for
recent projects and have found it focuses my thinking and helps me communicate
project goals to others. GitHub's support for Markdown, Textile, RDoc, and
others means rich formatted Readme files that can contain links, tables, and
code snippets.
So what makes a good Readme? Here are some critical items you should consider:
- Description - I'm surprised at how many times I land on a project page that
is obviously popular (because Twitter told me so) but I have no idea why
because the project owners don't tell me plainly what the project is or why I
should care.
- Installation instructions - Tell me where to get the bits and how to install
them
- Where to get help - Link to the docs, mailing list, wiki, etc.
- Contribution guidelines - Tell me how I can help out including wanted
features and code standards
- Contributor list - List the humans behind the project
- Credits, Inspiration, Alternatives - Tell me if this is a fork of or
otherwise inspired by another project. I won't think you're a douche when I
find out later."
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.nuxeo.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
_______________________________________________
ECM-tickets mailing list
[email protected]
http://lists.nuxeo.com/mailman/listinfo/ecm-tickets
