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.

Sign up for GitHub

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

Update new feature template to add user story requirement #2166

Merged
merged 2 commits into from
Feb 12, 2023
Merged

Update new feature template to add user story requirement #2166

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf5eed1
Add user story to issue template
ZeLonewolf Feb 11, 2023
01c378e
Simplify feature request template
ZeLonewolf Feb 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 10 additions & 35 deletions .github/ISSUE_TEMPLATE/Feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,26 @@ about: Suggest a feature or enhancement

---

## Motivation
## User Story

<!--
What problem are we trying to solve? Please link any relevant issues.
What use cases are we trying to accommodate?
This section should have a one-sentence sentence user story, such as:

Focus on the problem and save design ideas for the next section.
-->

## Design Alternatives

<!--
How could we accommodate the use cases above?
Is "do nothing" an option?
-->

## Design
As a <role> I can <capability>, so that <receive benefit>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't these "<" disappear due to markdown stuff?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's all within the <!-- --> HTML comment blocks so everything within will disappear if not edited.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right...


<!--
Which design should we implement?
What are the advantages of this design?
What are some potential drawbacks of this design?
-->

### Mock-Up

<!--
What will this design look like to developers?
What will this design look like to end users?
See also: https://en.wikipedia.org/wiki/User_story#Common_templates
-->

### Concepts
## Rationale

<!--
How will we teach this design?
What terminology will work best for the new concepts introduced by this design?
What existing precedents support the new concepts?
Where do the concepts set new precedents?
- Why is this feature needed?
- What are some example use cases?
- Can it be done today? Is there a workaround?
-->

### Implementation
## Impact

<!--
How you would implement the design in Javascript?
How you would implement the design in C++?
What parts of the Mapbox GL ecosystem will need to change to accommodate this design?
Are there any important edge cases?
- What if we do nothing? What is the impact to end-users if we don't implement this feature?
-->