Reporting an Issue - SAP/fundamental-styles GitHub Wiki

We welcome feedback and input from all of our stakeholders and followers. When making an request, whether it is for a brand new component, alerting us to a bug, or for an improvement to our toolkit or website, we require details about your request. All issues will be assessed by our team. Please illustrate your reasoning and demonstrate the need to helps us when reviewing your request.

Please see below for more details.

COMPONENT REQUEST

When requesting a brand new component or enhancement to an existing component, please include sketches, wireframes, and detailed descriptions as required to explain the need and use cases.

Component name

Propose a new or variant name

Detailed description

Describe the request

What offering/product do you work on? Any pressing ship or release dates we should be aware of?

What front-end framework are you implementing in, e.g., Angular, React, etc.?

Use case

Describe when to use (and when not to use)

Visual style

Describe specific needs related to color, typography, iconography, borders, space, size, and other visual properties.

Describe how to arrange multiple instances and other alignment specifics.

How should this respond to common contexts, i.e., touch, RTL, small screens.

Describe interactive states, e.g., disabled, expanded, pressed.

Expected behavior

How should this handle events, outcomes, and transitions

What states should be available, i.e., nothing, loading, none, one, some, too many, incorrect, correct, done.

Editorial

Advise on labels, tone, length, punctuation, truncation.

Additional information

  • Screenshots or code
  • Notes

BUG REPORT

We do make mistakes and appreciate when our users let us know. If you find a typo or a bug in the library, please include links and screenshots to illustrate the problem. Information about your system and browser are also valuable.

Describe the bug A clear and concise description of what the bug is.

Is this issue related to a specific component?

What version of Fundamental Styles are you using?

What offering/product do you work on? Any pressing ship or release dates we should be aware of?

What front-end framework are you implementing in, e.g., Angular, React, etc.?

To Reproduce Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context Add any other context about the problem here.

FEATURE REQUEST

If you have an idea on how we can improve the experience of using and learning about Fundamental Styles, we welcome your input. Be specific and include links and screenshots to help us understand your request.

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Is this issue related to a specific component?

What browser are you working in?

What version of Fundamental Styles are you using?

What offering/product do you work on? Any pressing ship or release dates we should be aware of?

What front-end framework are you implementing in, e.g., Angular, React, etc.?

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.