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] encapsulation issue in ImageLab.java #61

Open
5 tasks done
cgamble2 opened this issue Dec 5, 2020 · 4 comments
Open
5 tasks done

[UserStory] encapsulation issue in ImageLab.java #61

cgamble2 opened this issue Dec 5, 2020 · 4 comments
Labels
E: 2 Effort: 2 Story-Points user story User Story

Comments

@cgamble2
Copy link

cgamble2 commented Dec 5, 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 maintainer
I want ImageLab.java to have proper encapsulation
so that the internal implementation does not affect the external API

Supporting Info

This design change may require refactoring or modifications to the internal design of other classes.

Acceptance Criteria

Any instance variables of ImageLab.java that need to be accessed or modified by other classes are private and have accessor methods.

Dependencies

Depends On

issue #32

@cgamble2 cgamble2 added the user story User Story label Dec 5, 2020
@jody jody added the E: 2 Effort: 2 Story-Points label Dec 5, 2020
@jody
Copy link
Contributor

jody commented Dec 5, 2020

We do not need a stringent requirement for getter and setter methods for instance variables. We would only required them where there's explicit needs for that information to be accessed or modified from outside the class.

Because is not a refactoring of the ImageLab class (it changes the interface of the class), it would be useful to maintainers to explicitly mention that internal designs of other classes may need to be modified as a result of this issue's design change.

@cgamble2
Copy link
Author

cgamble2 commented Dec 6, 2020

I updated the issue description in accordance to your concern. Please let me know if this information is sufficient.

@jody
Copy link
Contributor

jody commented Dec 6, 2020

The supporting info looks good!

It appears that there are no Acceptance Criteria, which means there's no way to determine whether or not a PR actually satisfies this User story.

@jody
Copy link
Contributor

jody commented Dec 6, 2020

Completed triage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E: 2 Effort: 2 Story-Points user story User Story
Projects
None yet
Development

No branches or pull requests

2 participants