commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject Re: [ALL] Auto generating README.md and CONTRIBUTING.md for github using the commons build plugin
Date Wed, 27 Aug 2014 13:53:40 GMT
Looks good!

Gary


On Wed, Aug 27, 2014 at 9:11 AM, Benedikt Ritter <britter@apache.org> wrote:

> Hi all,
>
> I have worked on this some more. Today I included a new mojo that can
> generate a CONTRIBUTING.md for you. An example of how the generated file
> looks at github can be found here [1]. Please review the contents and add
> anything you think is missing :-)
>
> Thanks,
> Benedikt
>
> [1]
>
> https://github.com/britter/commons-csv/blob/readme-md-mojo-test/CONTRIBUTING.md
>
>
> 2014-08-23 10:50 GMT+02:00 Benedikt Ritter <britter@apache.org>:
>
> >
> >
> >
> > 2014-08-21 6:03 GMT+02:00 Stefan Bodewig <bodewig@apache.org>:
> >
> > On 2014-08-20, Benedikt Ritter wrote:
> >>
> >> > 2014-08-20 13:13 GMT+02:00 Stefan Bodewig <bodewig@apache.org>:
> >>
> >> >> On 2014-08-20, Benedikt Ritter wrote:
> >>
> >> >>> I've committed a new mojo to the commons build plugin, which
> >> generates a
> >> >>> README.md file for a component [1].
> >>
> >> >> Without looking at the code, do you plan to make it so that projects
> >> can
> >> >> override the default README.md with a template of their own - much
> like
> >> >> we currently allow for the download page?  I can see myself wanting
> to
> >> >> put more information there than the description from the POM at one
> >> >> point in time.
> >>
> >> > That is possible? Didn't know that until now :o)
> >>
> >> I think so, yes.  May be wrong.  Please note this is not a showstopper,
> >> though.  Having those pages and generating them is a good idea.
> >>
> >
> >
> > Hello Stefan,
> >
> > I've looked into the code again. I don't thing specifing a custom
> template
> > is possible. In generate-xdocs.build.xml an ant javaresource is used to
> > load the templates [1], so I think only templates that are packaged into
> > the build plugin can be loaded. Can you confirm?
> >
> >
> >>
> >> > Anyway, the idea was to put only the most essential information into
> >> > README.md and point people to the project's website, since I don't
> >> think we
> >> > should duplicate the information from the website in README.md...
> >>
> >> I agree with that.  What I have in mind right now is telling people
> >> which branch does what in case a project has multiple branches that may
> >> be under development as branches are way more visible at github.  Like
> >> "master is for the current Foo 3.x releases while foo-2.x is for
> >> the maintenance of the legacy 2.x releases.  foo-1.x is no longer under
> >> active development.".
> >>
> >
> > Makes sense to me.
> >
> > Benedikt
> >
> > [1]
> >
> http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml?view=markup
> >
> >
> >>
> >> Stefan
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> >> For additional commands, e-mail: dev-help@commons.apache.org
> >>
> >>
> >
> >
> > --
> > http://people.apache.org/~britter/
> > http://www.systemoutprintln.de/
> > http://twitter.com/BenediktRitter
> > http://github.com/britter
> >
>
>
>
> --
> http://people.apache.org/~britter/
> http://www.systemoutprintln.de/
> http://twitter.com/BenediktRitter
> http://github.com/britter
>



-- 
E-Mail: garydgregory@gmail.com | ggregory@apache.org
Java Persistence with Hibernate, Second Edition
<http://www.manning.com/bauer3/>
JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
Spring Batch in Action <http://www.manning.com/templier/>
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message