For my 2c, I could see having one file, where the read me part is on top,
followed by the release notes. That's what I'd want to see on the GitHub
main page. This let's me see how to get started with some high level info
followed by the history of releases.

Keeping things separate is also ok with me. It's just nice to see in the
RN, for example:

Version 5.1
- Requires Java 7
- Source compatible with 5.0.3
- Binary compatible with 5.0.3

G

Gary

On Mon, Mar 29, 2021, 14:04 Oleg Kalnichevski <ol...@apache.org> wrote:

> On Mon, 2021-03-29 at 13:53 -0400, Gary Gregory wrote:
> > Hi Oleg,
> >
> > It's nice to see up front it so you don't have to know the history.
> > Too
> > many projects out there make this hard to find on their site and
> > release
> > notes, some don't mention it, so you have to look at POM files which
> > is
> > lame IMO. To me, this is part of the user friendly aspect of a
> > project,
> > just set the expectations, don't hide info or make me go search for
> > it.
> >
>
> Makes it unclear to me what then we need README for?
>
> Shall we delete README and have one less file to maintain?
>
> Oleg
>
> > Gary
> >
> > On Mon, Mar 29, 2021, 12:45 Oleg Kalnichevski <ol...@apache.org>
> > wrote:
> >
> > >
> > > On 3/29/2021 6:06 PM, Gary Gregory wrote:
> > > > It would be nice if the RN listed the required Java version.
> > > >
> > >
> > > Hi Gary.
> > >
> > > The Java version has not changed in this release. It is still the
> > > same
> > > as in 5.0. Java 1.8 upgrade is planned for 5.2. Required Java
> > > version is
> > > stated in README.md
> > >
> > > Do you still have to mention it in the 5.1 release notes?
> > >
> > > Oleg
> > >
> > >
> > > > Gary
> > > >
> > > >
> > > > On Mon, Mar 29, 2021, 11:14 Oleg Kalnichevski <ol...@apache.org>
> > > > wrote:
> > > >
> > > > > Folks
> > > > >
> > > > > Please review the release notes for HttpClient 5.1 release and
> > > > > update /
> > > > > amend as necessary.
> > > > >
> > > > >
> > > > >
> > >
> https://github.com/apache/httpcomponents-client/blob/master/RELEASE_NOTES.txt
> > > > > Oleg
> > > > >
> > > > >
> > > > >
> > > > >
> > > > > -------------------------------------------------------------
> > > > > --------
> > > > > To unsubscribe, e-mail: dev-unsubscr...@hc.apache.org
> > > > > For additional commands, e-mail: dev-h...@hc.apache.org
> > > > >
> > > > >
> > >
> > > -----------------------------------------------------------------
> > > ----
> > > To unsubscribe, e-mail: dev-unsubscr...@hc.apache.org
> > > For additional commands, e-mail: dev-h...@hc.apache.org
> > >
> > >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@hc.apache.org
> For additional commands, e-mail: dev-h...@hc.apache.org
>
>

Reply via email to