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

[RFC]: Target setting merging #818

Open
5 tasks
dannyvv opened this issue Nov 7, 2024 · 0 comments
Open
5 tasks

[RFC]: Target setting merging #818

dannyvv opened this issue Nov 7, 2024 · 0 comments
Assignees

Comments

@dannyvv
Copy link
Member

dannyvv commented Nov 7, 2024

In progress

Overview

Provide a high level summary of the feature you are trying to build

Definitions of terms

term 1
definition 1
term 1
definition 1
term 1
definition 1

Goals & non-goals

Upstream dependencies

  1. dep 1
  2. dep 2
  3. dep 3

Downstream dependencies

  1. dep 1
  2. dep 2
  3. dep 3

Detailed Design

  • Use diagrams

You can use mermaid:

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
Loading

Use images by drag & drop

  • Describe different feature areas and how they are architected (designed)
  • Make sure another set of developer can roughly understand how your code will be organized after reading this section!

Test Plan

  • How will you make sure these features are to be tested
  • Specify if leveraging any NEW test framework or techniques

Performance, Resilience, Monitoring

  • Discuss any impact on performance (both as a developer and as a consumer)
  • Any expected change in the ability to deal with spotty networks (resilience?)
  • How will you monitor or collect telemetry on the features?

Security & Privacy

  • Will the feature have any security or privacy issues?
  • What are some ways to mitigate these issues?

Accessibility

  • How will your feature conform to accessibility guidelines
  • Check on how you will handle:
    • Keyboard navigation
    • Screen Readers
    • Multiple monitor resolutions
    • High DPI support
    • High Contrast support

World Readiness

  • Globalization: how does yoru feature invoke display or manipulate display of currency, dates, timezones, names?
  • Localization: how does your feature address localization?

Execution Plan

List out the work items and/or PRs here:

  • Work item 1: PR 1
  • Work item 2: work item 2
  • Work item 3:
    • PR 3
    • PR 4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants