[
https://issues.apache.org/jira/browse/TINKERPOP3-791?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
stephen mallette updated TINKERPOP3-791:
----------------------------------------
Issue Type: Improvement (was: Task)
Here's something I just ran into with release notes. I just made a change
related to a JIRA issue: TINKERPOP3-764 . So presumably, I shouldn't need to
edit the release notes manually at this time because we'll be able to catch
them at the time we generate the report on release. Of course, the title of
this issue is "Consider CLOSE_BEHAVIOR Operations" which is what would show in
the release notes. Now, where I see a problem is that the title doesn't really
reflect what I did and my changes were in fact important for vendors because I
altered the naming/semantics of a test slightly for this change which could
break their implementation (hoping it doesn't - slim chance but a chance
nonetheless).
So I think that yields two issues:
1. Titles alone might not always be good release notes.
2. There are subtle changes that might be important that should be documented
in the release notes and would likely be forgotten by the time we get to
release to generate the report and rectify the report against the release notes.
I guess the answer might be to not worry about trying to rectify the two lists.
Include the manual list and the JIRA list. if a JIRA title is exactly what
was done and it can be relied on for easy understanding in the release notes
then there is no need to manually document it. So in the case of the JIRA
issue i mentioned, I should manually edit the release notes and include my
changes as there are subtleties to be considered.
I also think we should have some way to distinguish breaking change. Without
adding too much formatting to what we have, I think that, minimally, we could
just make sure "breaking change" is first in the list and that we don't rely on
JIRA issues to convey breaking change. Such things should always be documented
manually.
> Document rules for committers
> -----------------------------
>
> Key: TINKERPOP3-791
> URL: https://issues.apache.org/jira/browse/TINKERPOP3-791
> Project: TinkerPop 3
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 3.0.0-incubating
> Reporter: Matt Frantz
> Assignee: Matt Frantz
> Fix For: 3.0.1-incubating, 3.1.0-incubating
>
>
> Add some text to CONTRIBUTING.asciidoc on best practices for committers.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
