[xwiki-devs] [Proposal] README.md Template for xwiki-contrib extensions
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+application> * 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
Note that we have one alternative but it would require improvements to the Repository Application: We could say to only have a link to the exo page and have all the information present on that page. What’s missing ATM: * Name of lead * Development practices * Minimal XWiki version supported Pros: * No duplicated information Cons: * Less info displayed right away when you browse extension repositories on github Thanks -Vincent On 10 Feb 2016 at 14:25:24, [email protected] ([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 ————— # <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+application> * 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
On 10 Feb 2016 at 14:36:15, [email protected] ([email protected]) wrote: Note that we have one alternative but it would require improvements to the Repository Application: We could say to only have a link to the exo page and have all the information present on that page. What’s missing ATM: * Name of lead * Development practices * Minimal XWiki version supported * Link to CI * Link to Sonar Thanks -Vincent Pros: * No duplicated information Cons: * Less info displayed right away when you browse extension repositories on github Thanks -Vincent On 10 Feb 2016 at 14:25:24, [email protected] ([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 ————— # <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+application> * 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
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information) and maybe there are some other particular steps to follow when a release is performed. A good example would be: https://github.com/xwiki-contrib/application-filemanager/blob/master/README.... Thanks
Hi Alex, On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ([email protected](mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong. OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be: https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
+1 for the first proposal. Having informations in the github repo is more friendly. 2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ([email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
+1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau <[email protected]> wrote:
+1 for the first proposal. Having informations in the github repo is more friendly.
2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ([email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
On 10 Feb 2016 at 15:01:54, Thomas Mortagne ([email protected]) wrote: +1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule Yes it would be an ecouraged best practice. Thanks -Vincent On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau <[email protected]> wrote:
+1 for the first proposal. Having informations in the github repo is more friendly.
2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ([email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
+1. It`s always good to have some guidance. Also, the project lead field should be a bit more useful than a name. Maybe github account, IRC handle or something like this might be useful as well, as a means of contacting the person. It won`t always be well known XWiki committers there. Thanks, Eduard On Wed, Feb 10, 2016 at 4:03 PM, [email protected] <[email protected]> wrote:
On 10 Feb 2016 at 15:01:54, Thomas Mortagne ([email protected]) wrote:
+1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule Yes it would be an ecouraged best practice.
Thanks
-Vincent
On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau <[email protected]> wrote:
+1 for the first proposal. Having informations in the github repo is more friendly.
2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ( [email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On 11 Feb 2016 at 12:07:45, Eduard Moraru ([email protected]) wrote: +1. It`s always good to have some guidance. Also, the project lead field should be a bit more useful than a name. Maybe github account, IRC handle or something like this might be useful as well, as a means of contacting the person. It won`t always be well known XWiki committers there. Link to the xwiki.org user profile page? (there the user can put whatever info he wants to be found) Thanks -Vincent Thanks, Eduard On Wed, Feb 10, 2016 at 4:03 PM, [email protected] <[email protected]> wrote:
On 10 Feb 2016 at 15:01:54, Thomas Mortagne ([email protected]) wrote:
+1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule Yes it would be an ecouraged best practice.
Thanks
-Vincent
On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau <[email protected]> wrote:
+1 for the first proposal. Having informations in the github repo is more friendly.
2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ( [email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Thu, Feb 11, 2016 at 12:09 PM, [email protected] <[email protected]> wrote:
On 11 Feb 2016 at 12:07:45, Eduard Moraru ([email protected]) wrote:
+1. It`s always good to have some guidance.
Also, the project lead field should be a bit more useful than a name. Maybe github account, IRC handle or something like this might be useful as well, as a means of contacting the person. It won`t always be well known XWiki committers there.
Link to the xwiki.org user profile page? (there the user can put whatever info he wants to be found)
We should probably add a field in the profile for the github account.
Thanks
-Vincent
Thanks, Eduard
On Wed, Feb 10, 2016 at 4:03 PM, [email protected] <[email protected]> wrote:
On 10 Feb 2016 at 15:01:54, Thomas Mortagne ([email protected]) wrote:
+1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule Yes it would be an ecouraged best practice.
Thanks
-Vincent
On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau <[email protected]> wrote:
+1 for the first proposal. Having informations in the github repo is more friendly.
2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ( [email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
To be honest I would love that this info would be in e.x.o. On git we have a link to the website of the app. There we could put all the info inside the Repository app. Otherwise we will duplicate information, have it desync, etc. Thanks, Caty On Thu, Feb 11, 2016 at 1:24 PM, Thomas Mortagne <[email protected]> wrote:
On Thu, Feb 11, 2016 at 12:09 PM, [email protected] <[email protected]> wrote:
On 11 Feb 2016 at 12:07:45, Eduard Moraru ([email protected]) wrote:
+1. It`s always good to have some guidance.
Also, the project lead field should be a bit more useful than a name.
Maybe
github account, IRC handle or something like this might be useful as well, as a means of contacting the person. It won`t always be well known XWiki committers there.
Link to the xwiki.org user profile page? (there the user can put whatever info he wants to be found)
We should probably add a field in the profile for the github account.
Thanks
-Vincent
Thanks, Eduard
On Wed, Feb 10, 2016 at 4:03 PM, [email protected] <[email protected]> wrote:
On 10 Feb 2016 at 15:01:54, Thomas Mortagne ([email protected]) wrote:
+1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule Yes it would be an ecouraged best practice.
Thanks
-Vincent
On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau <[email protected]> wrote:
+1 for the first proposal. Having informations in the github repo is
more
friendly.
2016-02-10 14:53 GMT+01:00 [email protected] <[email protected]>:
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ( [email protected] (mailto:[email protected])) wrote:
+ 1 I would also propose to add the Java version needed for release (instead of digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
and maybe there are some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
A good example would be:
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On 11 Feb 2016 at 16:41:23, Ecaterina Moraru (Valica) ([email protected](mailto:[email protected])) wrote:
To be honest I would love that this info would be in e.x.o.
On git we have a link to the website of the app. There we could put all the info inside the Repository app. Otherwise we will duplicate information, have it desync, etc.
@Caty, this is what I mentioned already in my mail. So far, Guillaume said he preferred not to do this and have explicit info instead. Also note that we need the README anyway **for now** since the Repository app (and what’s installed on exo) is missing a lot of the needed info (see details in my first mail). Unless you think it’s better to not have anything at all till the Repository app on exo is updated (which might possibly be in a long time in the future). I’m open to both ideas as I mentioned in my initial mails. Thanks -Vincent
Thanks, Caty
On Thu, Feb 11, 2016 at 1:24 PM, Thomas Mortagne wrote:
On Thu, Feb 11, 2016 at 12:09 PM, [email protected] wrote:
On 11 Feb 2016 at 12:07:45, Eduard Moraru ([email protected]) wrote:
+1. It`s always good to have some guidance.
Also, the project lead field should be a bit more useful than a name.
Maybe
github account, IRC handle or something like this might be useful as well, as a means of contacting the person. It won`t always be well known XWiki committers there.
Link to the xwiki.org user profile page? (there the user can put whatever info he wants to be found)
We should probably add a field in the profile for the github account.
Thanks
-Vincent
Thanks, Eduard
On Wed, Feb 10, 2016 at 4:03 PM, [email protected] wrote:
On 10 Feb 2016 at 15:01:54, Thomas Mortagne ([email protected]) wrote:
+1 to provide this template on contrib.xwiki.org as a best practice for those who want to use it but not a big fan of making it a rule Yes it would be an ecouraged best practice.
Thanks
-Vincent
On Wed, Feb 10, 2016 at 2:55 PM, Guillaume Delhumeau wrote:
+1 for the first proposal. Having informations in the github repo is
more
friendly.
2016-02-10 14:53 GMT+01:00 [email protected] :
Hi Alex,
On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ( [email protected] (mailto:[email protected])) wrote:
> + 1 > I would also propose to add the Java version needed for release (instead of > digging in the hierarchy to find out this information)
I don’t agree. I think we should only put the minimal number of information as it’s very tedious to ensure that the info is in sync. Right now I’ve put only what I think is the minimal info. Also the Java version is checked during the build so you cannot have it wrong.
OTOH I see there’s a link to Translations on l10n. I think that’s a good idea for apps that support internationalization. Would be optional.
> and maybe there are > some other particular steps to follow when a release is performed.
The template is about the minimal that need to be displayed. We should mention that of course each repo should add whatever information it needs/wants to that README.
> A good > example would be: >
https://github.com/xwiki-contrib/application-filemanager/blob/master/README....
Thanks -Vincent
Hi, I’ve documented it here: http://contrib.xwiki.org/xwiki/bin/view/Main/#HREADME.mdTemplate Let’s try to follow this and we’ll improve it as we progress. 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
I'm not very fond of the "Others" heading. I would: - remove the Other heading, just add the rest in the list - have the status last: since it adds an image Thanks, Caty On Mon, Feb 15, 2016 at 5:50 PM, [email protected] <[email protected]> wrote:
Hi,
I’ve documented it here: http://contrib.xwiki.org/xwiki/bin/view/Main/#HREADME.mdTemplate
Let’s try to follow this and we’ll improve it as we progress.
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
On 15 Feb 2016 at 17:25:44, Ecaterina Moraru (Valica) ([email protected](mailto:[email protected])) wrote:
I'm not very fond of the "Others" heading. I would: - remove the Other heading, just add the rest in the list - have the status last: since it adds an image
+1 Another point: since on http://contrib.xwiki.org/xwiki/bin/view/Main/#HHostingtools we mention mailing list, do we want to plan for the future and explicitly point to the http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists lists for now? (note that xclams has its own dv list for example). I feel it would be good and since this doesn’t change often, it shouldn’t be too much of a maintenance burden. WDYT? Thanks -Vincent
Thanks, Caty
On Mon, Feb 15, 2016 at 5:50 PM, [email protected] wrote:
Hi,
I’ve documented it here: http://contrib.xwiki.org/xwiki/bin/view/Main/#HREADME.mdTemplate
Let’s try to follow this and we’ll improve it as we progress.
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
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
than maybe we will want to also list the IRC channel. I don't know if it's necessary, but it's kind of included in the "Development Practices" area, since we list on devs.xwiki.org what is the mailinglist and the IRC channel. Thanks, Caty On Mon, Feb 15, 2016 at 6:32 PM, [email protected] <[email protected]> wrote:
On 15 Feb 2016 at 17:25:44, Ecaterina Moraru (Valica) ([email protected] (mailto:[email protected])) wrote:
I'm not very fond of the "Others" heading. I would: - remove the Other heading, just add the rest in the list - have the status last: since it adds an image
+1
Another point: since on http://contrib.xwiki.org/xwiki/bin/view/Main/#HHostingtools we mention mailing list, do we want to plan for the future and explicitly point to the http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists lists for now? (note that xclams has its own dv list for example).
I feel it would be good and since this doesn’t change often, it shouldn’t be too much of a maintenance burden.
WDYT?
Thanks -Vincent
Thanks, Caty
On Mon, Feb 15, 2016 at 5:50 PM, [email protected] wrote:
Hi,
I’ve documented it here: http://contrib.xwiki.org/xwiki/bin/view/Main/#HREADME.mdTemplate
Let’s try to follow this and we’ll improve it as we progress.
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
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On 15 Feb 2016 at 17:35:42, Ecaterina Moraru (Valica) ([email protected](mailto:[email protected])) wrote:
than maybe we will want to also list the IRC channel.
I don't know if it's necessary, but it's kind of included in the "Development Practices" area, since we list on devs.xwiki.org what is the mailinglist and the IRC channel.
* What I’d like is to list how each extension uses the tools we’re providing. The full list of tools is at http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome#HHostingtools * I think the mailing list is an important piece of information for someone who want to contribute to an extension * Even if it’s mostly the same everywhere, it makes it explicit and prepares the field for the future. * We could group IRC + ML together under the label “Communication:”. We would use: “Communication: [Mailing List](...) & [IRC](...)" * I’d really prefer to list all tools and use N/A when it’s not used instead of not listing them when not used since we never know if the tool is not listed because its not used or if it’s been forgotten. WDYT? Thanks -Vincent
Thanks, Caty
On Mon, Feb 15, 2016 at 6:32 PM, [email protected] wrote:
On 15 Feb 2016 at 17:25:44, Ecaterina Moraru (Valica) ([email protected] (mailto:[email protected])) wrote:
I'm not very fond of the "Others" heading. I would: - remove the Other heading, just add the rest in the list - have the status last: since it adds an image
+1
Another point: since on http://contrib.xwiki.org/xwiki/bin/view/Main/#HHostingtools we mention mailing list, do we want to plan for the future and explicitly point to the http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists lists for now? (note that xclams has its own dv list for example).
I feel it would be good and since this doesn’t change often, it shouldn’t be too much of a maintenance burden.
WDYT?
Thanks -Vincent
Thanks, Caty
On Mon, Feb 15, 2016 at 5:50 PM, [email protected] wrote:
Hi,
I’ve documented it here: http://contrib.xwiki.org/xwiki/bin/view/Main/#HREADME.mdTemplate
Let’s try to follow this and we’ll improve it as we progress.
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
I prefer to use markdown link syntax instead of pasting the full URL, as in https://github.com/xwiki-contrib/application-filemanager/commit/a76c76c33b34... . I doubt anyone is interested in the URL per se. What's important is to have a link to the documentation, issue tracker, etc. On Wed, Feb 10, 2016 at 3:25 PM, [email protected] <[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 ————— # <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+applicat...
* 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
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On 1 Mar 2016 at 17:16:37, Marius Dumitru Florea ([email protected](mailto:[email protected])) wrote:
I prefer to use markdown link syntax instead of pasting the full URL, as in https://github.com/xwiki-contrib/application-filemanager/commit/a76c76c33b34... . I doubt anyone is interested in the URL per se. What's important is to have a link to the documentation, issue tracker, etc.
Yes +1 to that. Thanks -Vincent
On Wed, Feb 10, 2016 at 3:25 PM, [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 ————— #
pom.xml>
* Project Lead: * Extension Page(s): > > http://extensions.xwiki.org/xwiki/bin/view/Extension/Flash+messages+applicat...
* Issue Tracker: > > http://jira.xwiki.org/browse/XAFLASHM> * License: . * Development Practices: > > pointing to a site defining the list of practices to be followed by contributors when contributing on this project> * Minimal XWiki version supported: > > 6.4.7>
## Others () * Continuous Integration Status: [](http://ci.xwiki.org/job/> > ci.xwiki.org>/) * Sonar Dashboard: > > e.g. http://sonar.xwiki.org/dashboard/index/10464> —— stop here ————---
Example: https://github.com/xwiki-contrib/application-antispam/tree/master
WDYT?
Thanks -Vincent
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
On Fri, Mar 4, 2016 at 11:56 AM, [email protected] <[email protected]> wrote: > 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? > +1, look good. Thanks, Marius > > 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 >
+1 I guess the project lead is still there until we decide to drop it. Not sure if we should mention somehow that the extension page also includes the download link (for anyone looking for available builds). Maybe this is not needed. Thanks, Eduard On Fri, Mar 4, 2016 at 12:11 PM, Marius Dumitru Florea < [email protected]> wrote: > On Fri, Mar 4, 2016 at 11:56 AM, [email protected] <[email protected]> > wrote: > > > 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? > > > > +1, look good. > > Thanks, > Marius > > > > > > 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 > > > _______________________________________________ > devs mailing list > [email protected] > http://lists.xwiki.org/mailman/listinfo/devs >
On 4 Mar 2016 at 12:00:41, Eduard Moraru ([email protected](mailto:[email protected])) wrote:
+1
I guess the project lead is still there until we decide to drop it.
Indeed.
Not sure if we should mention somehow that the extension page also includes the download link (for anyone looking for available builds). Maybe this is not needed.
This is a good point. We could say “[Documentation & Download](…)” instead of “Extension Page”. Thanks -Vincent
Thanks, Eduard
On Fri, Mar 4, 2016 at 12:11 PM, Marius Dumitru Florea < [email protected]> wrote:
On Fri, Mar 4, 2016 at 11:56 AM, [email protected] wrote:
So here’s the latest proposal I have, taking into account various comments:
--- start here ---- #
the pom.xml>
* Project Lead: [> > > Massol>](> > > * [Extension Page](> > > http://extensions.xwiki.org/xwiki/bin/view/Extension/Flash+messages+applicat...
)
* Extension Pages: ** [> > > ... ** [> > > * [Issue Tracker](> > > http://jira.xwiki.org/browse/XAFLASHM>) * Communication: [Mailing List](> > > http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists>), [IRC](> > > e.g. http://dev.xwiki.org/xwiki/bin/view/Community/IRC>)
* [Development Practices](> > > practices to be followed by contributors when contributing on this project>)
* Development Practices: ** ... **
* Minimal XWiki version supported: > > > 6.4.7> * License: .
* [Translations]()
* Translations: N/A
* [Sonar Dashboard](> > > e.g. http://sonar.xwiki.org/dashboard/index/10464>)
* Sonar Dashboard: N/A
* Continuous Integration Status: [](http://ci.xwiki.org/job/> > > ci.xwiki.org>/)
* Continuous Integration Status: N/A
## Whatever ….
--- 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?
+1, look good.
Thanks, Marius
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
Done at http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome#HREADME.mdTemplate Thanks everyone. -Vincent On 4 Mar 2016 at 12:06:05, [email protected] ([email protected]) wrote: On 4 Mar 2016 at 12:00:41, Eduard Moraru ([email protected](mailto:[email protected])) wrote:
+1
I guess the project lead is still there until we decide to drop it.
Indeed.
Not sure if we should mention somehow that the extension page also includes the download link (for anyone looking for available builds). Maybe this is not needed.
This is a good point. We could say “[Documentation & Download](…)” instead of “Extension Page”. Thanks -Vincent
Thanks, Eduard
On Fri, Mar 4, 2016 at 12:11 PM, Marius Dumitru Florea < [email protected]> wrote:
On Fri, Mar 4, 2016 at 11:56 AM, [email protected] wrote:
So here’s the latest proposal I have, taking into account various comments:
--- start here ---- #
the
pom.xml>
* Project Lead: [ Massol>](
* [Extension Page](
http://extensions.xwiki.org/xwiki/bin/view/Extension/Flash+messages+applicat...
)
* Extension Pages: ** [ ... ** [
* [Issue Tracker]( http://jira.xwiki.org/browse/XAFLASHM>) * Communication: [Mailing List]( http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists>), [IRC]( e.g. http://dev.xwiki.org/xwiki/bin/view/Community/IRC>)
* [Development Practices]( practices to be followed by contributors when contributing on this project>)
* Development Practices: ** ... **
* Minimal XWiki version supported: 6.4.7> * License: .
* [Translations]()
* Translations: N/A
* [Sonar Dashboard]( e.g. http://sonar.xwiki.org/dashboard/index/10464>)
* Sonar Dashboard: N/A
* Continuous Integration Status: [](http://ci.xwiki.org/job/ ci.xwiki.org>/)
* Continuous Integration Status: N/A
## Whatever ….
--- 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?
+1, look good.
Thanks, Marius
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
participants (7)
-
Alexandru Cotiuga -
Ecaterina Moraru (Valica) -
Eduard Moraru -
Guillaume Delhumeau -
Marius Dumitru Florea -
Thomas Mortagne -
vincent＠massol.net