Skip to content

Commit

Permalink
Add user story template (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
lilyminium authored Sep 29, 2023
1 parent 9e52363 commit a82fd01
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/user_stories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: User stories
about: Suggest new documentation from the perspective of a user!
title: ''
labels: ''
assignees: ''

---

**User story**
<!--
A user story is a description of a feature,
from the perspective of the user who desires it.
We appreciate all user stories that as long or short,
simple or detailed, as you like!
They typically follow a template like the below.
An example:
As an *infrequent user of MDAnalysis*,
I want to *easily know what the units of MDAnalysis are*,
so that *I don't accidentally mix up units in my analyses*.
-->

As a *[type of user]*, I want to *[some goal]*,
so that *[reason why]*.

**Additional context**

<!--
If there's any current documentation addressing similar issues
and why it doesn't solve the problem,
or any other additional context
-->

0 comments on commit a82fd01

Please sign in to comment.