Skip to content

Commit

Permalink
Add documentation template (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
christinach authored May 9, 2024
1 parent 7a509ea commit 9cd844f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Documentation
about: Create documentation
title: ''
labels: 'documentation'
assignees: ''

---
### Introduction
Explain the goals and purpose of this documentation.

### Acceptance criteria

- [ ] If there is no docs directory, create one.

- [ ] Update an existing markdown document or add a new one in the docs directory.

- [ ] It has introduction: Explains the goals and purpose of this documentation.

- [ ] It has a step by step guide: Provides the exact steps to guide the user on how to do a task.

#### Additional acceptance criteria
- [ ] It includes references: References any related resources that have assisted creating this documentation (links to other tickets, online articles etc.).

- [ ] It includes workflow: Defines the steps in different environments (production, staging)

0 comments on commit 9cd844f

Please sign in to comment.