Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UserStory] sound package checkstyle report #34

Closed
5 tasks done
GeoffZC opened this issue Apr 21, 2020 · 2 comments · Fixed by #42
Closed
5 tasks done

[UserStory] sound package checkstyle report #34

GeoffZC opened this issue Apr 21, 2020 · 2 comments · Fixed by #42
Assignees
Labels
user story User Story

Comments

@GeoffZC
Copy link
Contributor

GeoffZC commented Apr 21, 2020

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 checkstlye errors in the sound package to be fixed
so that the code adheres to coding style conventions.

Acceptance Criteria

Build runs without any checkstyle errors in the sound package.

*Zero checkstyle errors for the sound package.
*Full JavaDoc documentation in the sound package.
*Code runs without 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.

@GeoffZC GeoffZC added the user story User Story label Apr 21, 2020
@jody
Copy link
Contributor

jody commented Apr 21, 2020

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.

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

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

@GeoffZC
Copy link
Contributor Author

GeoffZC commented May 2, 2020

New pull request #41

@jody jody linked a pull request May 6, 2020 that will close this issue
@jody jody closed this as completed in #42 May 6, 2020
jody pushed a commit that referenced this issue May 6, 2020
Improves quality of code in sound package and files dependent on those changes, as requested in User Story #34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user story User Story
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants