Re: [xwiki-devs] [Proposal] README.md Template for xwiki-contrib extensions

On 11 Feb 2016 at 12:07:45, Eduard Moraru (enygma2002(a)gmail.com) wrote: +1. It`s always good to have some guidance. Also, the project lead field should be a bit more useful than a name.

github account, IRC handle or something like this might be useful as

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

Thanks -Vincent Thanks, Eduard On Wed, Feb 10, 2016 at 4:03 PM, vincent(a)massol.net <vincent(a)massol.net> wrote: > > > On 10 Feb 2016 at 15:01:54, Thomas Mortagne (thomas.mortagne(a)xwiki.com) > 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 > <guillaume.delhumeau(a)xwiki.com> wrote: > > +1 for the first proposal. Having informations in the github repo is

> > friendly. > > > > 2016-02-10 14:53 GMT+01:00 vincent(a)massol.net <vincent(a)massol.net>et>: > > > >> Hi Alex, > >> > >> On 10 Feb 2016 at 14:43:53, Alexandru Cotiuga ( > alexandru.cotiuga(a)xwiki.com > >> (mailto:alexandru.cotiuga@xwiki.com)) 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

> >> 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

> >> mention that of course each repo should add whatever information it > >> needs/wants to that README. > >> > >> > A good > >> > example would be: > >> > > >> >

_______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs _______________________________________________ devs mailing list devs(a)xwiki.org http://lists.xwiki.org/mailman/listinfo/devs