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

[STUB] Address pre-summer design debt in edit components #402

Open
24 tasks
jimmoffet opened this issue Dec 4, 2024 · 0 comments
Open
24 tasks

[STUB] Address pre-summer design debt in edit components #402

jimmoffet opened this issue Dec 4, 2024 · 0 comments
Labels
story User story

Comments

@jimmoffet
Copy link
Contributor

jimmoffet commented Dec 4, 2024

Overview

We should review the shared aspects of edit component designs that were created by engineering in spring. We should focus on simplicity and furling up less-used features where possible.

Context

Optional: Any reference material or thoughts we may need for later reference, or assumptions of prior or future work that's out of scope for this story.

  • In the early versions of our platform, wherever trade-offs are significant, we should bias toward simplicity for users and away from being able to handle all possible forms for all possible customers.

Acceptance Criteria

Required outcomes of the story

  • Artifacts plus interaction guidance for updates to some or all edit components

Research Questions

  • Optional: Any initial questions for research

Tasks

Research, design, and engineering work needed to complete the story.

Definition of done

The "definition of done" ensures our quality standards are met with each bit of user-facing behavior we add. Everything that can be done incrementally should be done incrementally, while the context and details are fresh. If it’s inefficient or “hard” to do so, the team should figure out why and add OPEX/DEVEX backlog items to make it easier and more efficient.

  • Behavior
    • Acceptance criteria met
    • Implementation matches design decisions
  • Documentation
    • ADRs (/documents/adr folder)
    • Relevant README.md(s)
  • Code quality
    • Code refactored for clarity and no design/technical debt
    • Adhere to separation of concerns; code is not tightly coupled, especially to 3rd party dependencies; dependency rule followed
    • Code is reviewed by team member
    • Code quality checks passed
  • Security and privacy
    • Automated security and privacy gates passed
  • Testing tasks completed
    • Automated tests pass
    • Unit test coverage of our code >= 90%
  • Build and deploy
    • Build process updated
    • API(s) are versioned
    • Feature toggles created and/or deleted. Document the feature toggle
    • Source code is merged to the main branch

Decisions

  • Optional: Any decisions we've made while working on this story
@jimmoffet jimmoffet added the story User story label Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story User story
Projects
None yet
Development

No branches or pull requests

1 participant