[Hawkular-dev] Spring cleaning

Thomas Heute theute at redhat.com
Wed May 20 11:18:17 EDT 2015


Some of you may have noticed (sorry for the spam) but I was playing with 
HAWKULAR JIRA.

Few things:
	- Let's use the same terminology for the issues, this is JIRA's 
terminology:
		- Bug - A problem which impairs or prevents the functions of the product.
		- Feature Request - A new feature of the product, which has yet to be 
developed.
		- Task - A task that needs to be done.
		- Enhancement - An enhancement or refactoring of existing functionality

	Try to think from an Hawkular *user* perspective, so that the release 
notes are meaningful. Everything could be a task or enhancement, but 
thinking from a user point of view, changing kettle->dist is a task not 
an enhancement. Adding something that was not possible before for the 
user is a "feature request" not to be considered an enhancement (even 
though it is obviously an enhancement of the project).

	This is my workflow:
		- If a feature is broken, this is a bug (Bonus points if you can tell 
which release was affected, for the moment it's easy as there was no 
release)
		- If a feature didn't exist, it is a feature request
		- If a feature exists and does things faster/better (things changed in 
the UI for better clarity) this is en enhancement
		- If it's something that the end user would not really care about 
(added a test, changed some build stuff), it's a task.

	- tasks/sub-tasks are evil (as they all have the same kind). Instead of 
https://issues.jboss.org/browse/HAWKULAR-123 let's use the 
"Fix-Version(+component)" and properly fill the type. If tasks need to 
be grouped, please use links.

	- before closing an issue, check if the type, component, resolution, 
fix-version are filled and correct. (once closed you can only 
edit/change by reopening the issue and can't do bulk changes)


Thanks, if we all do that, we'll have human readable release notes.

Thomas


More information about the hawkular-dev mailing list