Add CHANGELOG.md file

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

Add CHANGELOG.md file

Deepak Dixit-5
Hi Dev,

As we have already moved to git for the version control system, I propose
to add a changelog file to maintain the changelogs[1].
What is a changelog?

A changelog is a file which contains a curated, chronologically ordered
list of notable changes for each version of a project.
Why keep a changelog?

To make it easier for users and contributors to see precisely what notable
changes have been made between each release (or version) of the project.
Who needs a changelog?

People do. Whether consumers or developers, the end users of software are
human beings who care about what's in the software. When the software
changes, people want to know why and how.

We can have our own process to generate changelog, It may be either manual
entries, or some tool or using git log. We can discuss this independently.

https://keepachangelog.com/en/1.0.0/

Thanks & Regards
--
Deepak Dixit
ofbiz.apache.org
Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

holivier
+1 for CHANGELOG.adoc ;-)

Le 17/06/2020 à 07:52, Deepak Dixit a écrit :

> Hi Dev,
>
> As we have already moved to git for the version control system, I propose
> to add a changelog file to maintain the changelogs[1].
> What is a changelog?
>
> A changelog is a file which contains a curated, chronologically ordered
> list of notable changes for each version of a project.
> Why keep a changelog?
>
> To make it easier for users and contributors to see precisely what notable
> changes have been made between each release (or version) of the project.
> Who needs a changelog?
>
> People do. Whether consumers or developers, the end users of software are
> human beings who care about what's in the software. When the software
> changes, people want to know why and how.
>
> We can have our own process to generate changelog, It may be either manual
> entries, or some tool or using git log. We can discuss this independently.
>
> https://keepachangelog.com/en/1.0.0/
>
> Thanks & Regards
> --
> Deepak Dixit
> ofbiz.apache.org
>
Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

Carsten Schinzer
In reply to this post by Deepak Dixit-5
+1 for a CHANGELOG.md

Would this be maintained for all official release branches + trunk, right? Or official release branches only.
Regards

Carsten

Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

adityasharma
+1

Thanks and Regards,
Aditya Sharma


On Wed, Jun 17, 2020 at 12:57 PM Carsten Schinzer <
[hidden email]> wrote:

> +1 for a CHANGELOG.md
>
> Would this be maintained for all official release branches + trunk, right?
> Or official release branches only.
> Regards
>
> Carsten
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

Jacques Le Roux
Administrator
In reply to this post by Deepak Dixit-5
+1

I believe it would be better done manually with a community consensus.

Could someone probes me wrong?

Jacques

Le 17/06/2020 à 07:52, Deepak Dixit a écrit :

> Hi Dev,
>
> As we have already moved to git for the version control system, I propose
> to add a changelog file to maintain the changelogs[1].
> What is a changelog?
>
> A changelog is a file which contains a curated, chronologically ordered
> list of notable changes for each version of a project.
> Why keep a changelog?
>
> To make it easier for users and contributors to see precisely what notable
> changes have been made between each release (or version) of the project.
> Who needs a changelog?
>
> People do. Whether consumers or developers, the end users of software are
> human beings who care about what's in the software. When the software
> changes, people want to know why and how.
>
> We can have our own process to generate changelog, It may be either manual
> entries, or some tool or using git log. We can discuss this independently.
>
> https://keepachangelog.com/en/1.0.0/
>
> Thanks & Regards
> --
> Deepak Dixit
> ofbiz.apache.org

Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

Suraj Khurana-2
+1

--
Best Regards,
Suraj Khurana
Senior Technical Consultant


On Wed, Jun 17, 2020 at 5:08 PM Jacques Le Roux <
[hidden email]> wrote:

> +1
>
> I believe it would be better done manually with a community consensus.
>
> Could someone probes me wrong?
>
> Jacques
>
> Le 17/06/2020 à 07:52, Deepak Dixit a écrit :
> > Hi Dev,
> >
> > As we have already moved to git for the version control system, I propose
> > to add a changelog file to maintain the changelogs[1].
> > What is a changelog?
> >
> > A changelog is a file which contains a curated, chronologically ordered
> > list of notable changes for each version of a project.
> > Why keep a changelog?
> >
> > To make it easier for users and contributors to see precisely what
> notable
> > changes have been made between each release (or version) of the project.
> > Who needs a changelog?
> >
> > People do. Whether consumers or developers, the end users of software are
> > human beings who care about what's in the software. When the software
> > changes, people want to know why and how.
> >
> > We can have our own process to generate changelog, It may be either
> manual
> > entries, or some tool or using git log. We can discuss this
> independently.
> >
> > https://keepachangelog.com/en/1.0.0/
> >
> > Thanks & Regards
> > --
> > Deepak Dixit
> > ofbiz.apache.org
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

Swapnil M Mane
In reply to this post by Deepak Dixit-5
+1

- Best regards,
Swapnil M Mane,
ofbiz.apache.org



On Wed, Jun 17, 2020 at 11:23 AM Deepak Dixit <[hidden email]> wrote:

> Hi Dev,
>
> As we have already moved to git for the version control system, I propose
> to add a changelog file to maintain the changelogs[1].
> What is a changelog?
>
> A changelog is a file which contains a curated, chronologically ordered
> list of notable changes for each version of a project.
> Why keep a changelog?
>
> To make it easier for users and contributors to see precisely what notable
> changes have been made between each release (or version) of the project.
> Who needs a changelog?
>
> People do. Whether consumers or developers, the end users of software are
> human beings who care about what's in the software. When the software
> changes, people want to know why and how.
>
> We can have our own process to generate changelog, It may be either manual
> entries, or some tool or using git log. We can discuss this independently.
>
> https://keepachangelog.com/en/1.0.0/
>
> Thanks & Regards
> --
> Deepak Dixit
> ofbiz.apache.org
>
Reply | Threaded
Open this post in threaded view
|

Re: Add CHANGELOG.md file

Deepak Dixit-5
Here is the link for task
https://issues.apache.org/jira/browse/OFBIZ-11839

Thanks & Regards
--
Deepak Dixit
ofbiz.apache.org


On Thu, Jun 18, 2020 at 10:22 AM Swapnil M Mane <[hidden email]>
wrote:

> +1
>
> - Best regards,
> Swapnil M Mane,
> ofbiz.apache.org
>
>
>
> On Wed, Jun 17, 2020 at 11:23 AM Deepak Dixit <[hidden email]> wrote:
>
> > Hi Dev,
> >
> > As we have already moved to git for the version control system, I propose
> > to add a changelog file to maintain the changelogs[1].
> > What is a changelog?
> >
> > A changelog is a file which contains a curated, chronologically ordered
> > list of notable changes for each version of a project.
> > Why keep a changelog?
> >
> > To make it easier for users and contributors to see precisely what
> notable
> > changes have been made between each release (or version) of the project.
> > Who needs a changelog?
> >
> > People do. Whether consumers or developers, the end users of software are
> > human beings who care about what's in the software. When the software
> > changes, people want to know why and how.
> >
> > We can have our own process to generate changelog, It may be either
> manual
> > entries, or some tool or using git log. We can discuss this
> independently.
> >
> > https://keepachangelog.com/en/1.0.0/
> >
> > Thanks & Regards
> > --
> > Deepak Dixit
> > ofbiz.apache.org
> >
>