[UserStory] filters package checkstlye report

[GeoffZC]

User Story

Essential components

• Title describes the story
• Stakeholder type is identified
• Outcome is described
• Rationale is explicit
• Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a contributor
I want the checkstyle errors in the filters package to be fixed
so that the code adheres to coding style conventions.

Acceptance Criteria

Checkstyle report for filters package has no checkstyle errors.

*Zero checkstyle errors for the filters package.
*Full JavaDoc documentation in filters package.
*Build runs without checkstyle errors.

Supporting Information

(Relevant information, context, resources)

Dependencies

Depends On

(Issues on which this story depends)

Dependents

Issue #32 dependent on completion of this issue.

[jody]

The file attachment (main.zip) isn't viewable in GitHub and there's no context explaining what that file is or why it is there.

[jody]

I think this is part of an epic, so that "parent" issue should be identified (probably as a Dependent).

[jody]

Since this specifically mentions "filters" in the heading, the body of the User Story (e.g., Outcome, Acceptance Criteria) should likewise reference the "filters" package.

[nlaratta]

I'd like to be assigned to this issue

[robo-jones]

I believe that the current project build meets the intention of all acceptance criteria for this user story; checkstyle reports no errors in the filters package, and each class in the package has appropriate javadoc comments. The third acceptance criteria, "Build runs without checkstyle errors" is not only beyond the scope of this specific issue (as there are other packages in the project), but is also contrary to the newly revised issue #32 which states that "TODO" checkstyle 'errors' are acceptable.

This is the result of running checkstyle against the current build of ImageLab:

As such, I believe that this issue can be closed.

[jody]

Great! Thank you for verifying the acceptance criteria!