On Wed, 25 Oct 2023 at 11:28, Gary Gregory <garydgreg...@gmail.com> wrote:
>
> In older times, we were more concerned with providing a somewhat self
> contained source zip/tar.

Not sure how that is relevant.

> I am concerned that hyperlinking these files
> would add another step and be a hassle to GitHub users, like myself. I
> really like having at least all top level type of information in the Readme
> such that the repository presents itself as nicely as possible.

In which case, I suggest we merge the parent POM into every component,
to save having to look it up.

> Gary
>
> On Wed, Oct 25, 2023, 6:17 AM sebb <seb...@gmail.com> wrote:
>
> > These files can be generated by the build plugin.
> > As such, most of the information is duplicated across all the repositories.
> >
> > This is convenient for users - provided that it is up to date.
> >
> > The problem is that making any changes is very time-consuming:
> > - update build-plugin
> > - vote on release
> > - release plugin
> > - run the plugin in nearly every component (some have their own
> > versions of the files)
> >
> > It seems to me that the README file should only contain info specific
> > to the component, and should be maintained locally. The build plugin
> > could be used to provide an initial template, but should not clobber
> > an existing entry.
> >
> > CONTRIBUTING.md should be a link to a shared file (as is done with
> > SECURITY.md).
> > [It's now very easy to update the main site, so I think the
> > contributing info should be stored there.]
> >
> > Sebb
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> > For additional commands, e-mail: dev-h...@commons.apache.org
> >
> >

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org

Reply via email to