Hi devs,
I’d like to propose that we standardize on the following Template for README.md for all
extensions on xwiki-contrib and that we start modifying all repos to use it:
—— start here —————
# <Pretty name of Extension, e.g. Flash Messages Application>
<Short Description of Extension, taken from the description element in the pom.xml>
* Project Lead: <info taken from the jira project, e.g. Vincent Massol>
* Extension Page(s): <urls on e.x.o, e.g.
http://extensions.xwiki.org/xwiki/bin/view/Extension/Flash+messages+applica…
* Issue Tracker: <url on
jira.xwiki.org, e.g.
http://jira.xwiki.org/browse/XAFLASHM>
* License: <license,taken from the pom.xml, e.g. LGPL 2.1>.
* Development Practices: <either a sub list listing all practices or a URL pointing to
a site defining the list of practices to be followed by contributors when contributing on
this project>
* Minimal XWiki version supported: <taken from the pom.xml, e.g. XWiki 6.4.7>
## Others (<use N/A when not used>)
* Continuous Integration Status: [](http://ci.xwiki.org/job/<url-encoded job name on ci.xwiki.org>/)
* Sonar Dashboard: <url to the project’s dashboard on
sonar.xwiki.org,
e.g.
http://sonar.xwiki.org/dashboard/index/10464>
—— stop here ————---
Example:
https://github.com/xwiki-contrib/application-antispam/tree/master
WDYT?
Thanks
-Vincent