So here’s the latest proposal I have, taking into account various comments:
--- 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>](<url to user profile on xwiki.org) <if single extension page> * [Extension Page](<url on e.x.o, e.g. http://extensions.xwiki.org/xwiki/bin/view/Extension/Flash+messages+application>) </if single extension page> <if several extension pages> * Extension Pages: ** [<pretty name of page1, e.g. My App API](<url1 on e.x.o) ... ** [<pretty name of pageN, e.g. My App API](<urlN on e.x.o) </if several extension pages> * [Issue Tracker](<url on jira.xwiki.org, e.g. http://jira.xwiki.org/browse/XAFLASHM>) * Communication: [Mailing List](<url, e.g. http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists>), [IRC](<url, e.g. http://dev.xwiki.org/xwiki/bin/view/Community/IRC>) <if link pointing to all dev practices> * [Development Practices](<URL pointing to a site defining the list of practices to be followed by contributors when contributing on this project>) </if link pointing to all dev practices> <if no single link pointing to all dev practices> * Development Practices: ** <best practice 1, possibly with some link> ... ** <best practice N, possibly with some link> </if no single link pointing to all dev practices> * Minimal XWiki version supported: <taken from the pom.xml, e.g. XWiki 6.4.7> * License: <license,taken from the pom.xml, e.g. LGPL 2.1>. <if translation is used> * [Translations](<url on l10n to translations for this extension>) </if translation is used> <if translation is not used> * Translations: N/A </if translation is not used> <if sonar is used> </if sonar is used> * [Sonar Dashboard](<url to the project’s dashboard on sonar.xwiki.org, e.g. http://sonar.xwiki.org/dashboard/index/10464>) <if sonar is not used> * Sonar Dashboard: N/A </if sonar is not used> <if ci is used> * Continuous Integration Status: [](http://ci.xwiki.org/job/<url-encoded job name on ci.xwiki.org>/) </if ci is used> <if ci is not used> * Continuous Integration Status: N/A </if ci is not used> <optional> ## Whatever …. </optional> --- stop here ---- Example: https://github.com/xwiki-contrib/application-antispam/blob/master/README.md I’d like to start publishing this on contrib.xwiki.org today. Could we agree about it as a first version? Thanks -Vincent On 10 Feb 2016 at 14:25:24, [email protected] ([email protected](mailto:[email protected])) wrote: > 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 ————— > # > > > > * Project Lead: > * Extension Page(s): > * Issue Tracker: > * License: . > * Development Practices: > * Minimal XWiki version supported: > > ## Others () > * Continuous Integration Status: [](http://ci.xwiki.org/job//) > > * Sonar Dashboard: > —— stop here ————--- > > Example: > https://github.com/xwiki-contrib/application-antispam/tree/master > > WDYT? > > Thanks > -Vincent > _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
