commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Benedikt Ritter <brit...@apache.org>
Subject Re: [ALL] Auto generating README.md and CONTRIBUTING.md for github using the commons build plugin
Date Wed, 20 Aug 2014 11:23:34 GMT
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)
Since I pretty much copy-pasted the configuration from the mail-page mojo,
it could be that it's already possible. But I'll have a look. Shouldn't be
to hard to accomplish if we already provide that functionality for the
download page.

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


>
> > One thing we should consider is to create an additional template for a
> > CONTRIBUTION.md. If a github repo has such a file, it will be displayed
> to
>
> s/CONTRIBUTION/CONTRIBUTING/g
>

you're right, thanks!


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

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