[ 
https://issues.apache.org/jira/browse/ACCUMULO-3156?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14150343#comment-14150343
 ] 

Josh Elser commented on ACCUMULO-3156:
--------------------------------------

[~sonixbp], you asked me to capture how I create release notes. Generally, I 
start with the full list of changes for a given release and prune down to a 
list tickets that fall into one or many of the following:

# Performance impact
# API change
# Deployment change
# Critical bugfix
# "interesting" changes

There's a bit of leeway, so including some "fun" bugs in the release notes is 
always cool too :). We've taken to including documentation changes (just in the 
form of issue references), which I'm not entirely sure is that useful. We've 
also taken to including the amount of testing done by each party. If not 
directly useful for users, it's nice to have that information stored in one 
place for us to review again later.

Also, include some less technical information about the release itself (stats 
on contributions/changes/etc are always fun) in a paragraph describing the 
release to start out the release notes.

In general, remember that release notes are for the users and could sway a user 
from using or avoiding a given release. Make them useful and relevant for users.

> Document full release process
> -----------------------------
>
>                 Key: ACCUMULO-3156
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-3156
>             Project: Accumulo
>          Issue Type: Task
>            Reporter: Corey J. Nolet
>            Assignee: Corey J. Nolet
>
> This should apply both to people who are familiar with the release process 
> but want a quick checklist or people who are new to the release process and 
> have never done it before.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to