I have a weak preference for option #2, as this option really helps make
releases easy, and encourages a well thought-through commit process.
However a combo of #1 and #3 would also work well, and is less overhead.

Note: probably obvious, but whichever mechanism we choose, let's remember
to update this doc with clear instructions one it's in place:
https://mxnet.incubator.apache.org/community/contribute.html

On Fri, Nov 10, 2017 at 8:26 AM, Marco de Abreu <
[email protected]> wrote:

> I think option 1 and 3 would be good in combination. Meaningful titles
> should always be encouraged and adding a label during the merge process
> should only be a matter of seconds.
>
> I dislike option 2 because introduces an additional step, which also
> requires creating an account for JIRA, into the PR-process. This could
> discourage especially new people from creating PRs and in general are the
> other two approaches more than enough. I don’t think somebody would like to
> create a JIRA-ticket just because they’re submitting a PR to update some
> documentation.
>
> On Fri, Nov 10, 2017 at 2:26 AM, Suneel Marthi <[email protected]> wrote:
>
> > When u create a Jira - the jira carries a label of 'New Feature', 'Bug',
> > 'Task' etc..., there's no need to again label each PR individually as
> long
> > as the Jira### is referenced in the PR.
> >
> >
> >
> > On Fri, Nov 10, 2017 at 4:13 AM, Meghna Baijal <
> [email protected]
> > >
> > wrote:
> >
> > > Hello All,
> > >
> > > Currently, there is no process in place to identify the new features
> that
> > > go into every release.  All the commits since the previous release are
> > > manually parsed to find the important changes that go into the release
> > > notes.
> > >
> > >
> > > In order to improve this process, I want to start a discussion on the
> > > following options -
> > >
> > > 1. *Better PR titles* - if possible, these should be good enough to be
> > > picked as is into the release notes.
> > >
> > > 2. *JIRA Issues* - each commit should be tagged with an associated JIRA
> > > issue. This issue should describe the problem. JIRA tickets can be used
> > to
> > > automate the generation of release notes.
> > >
> > > 3. *Adding Labels to the PRs/Commits* - There can be a set of 3-5
> labels
> > > such as ‘Bug-Fix’, ‘New Feature’, ‘Docs’, ‘Minor Change’ etc. Atleast
> > those
> > > PRs which are important and should be included in the release notes
> > should
> > > be labeled.
> > > However, labels can only be added by those with write access to the
> repo.
> > > So the committers will have to triage this label addition as they
> > > review/merge the PRs.
> > >
> > >
> > > Do you think these changes are feasible? Will they help? What other
> > options
> > > should be considered?
> > >
> > > Thanks,
> > > Meghna Baijal
> > >
> >
>

Reply via email to