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

Add documentation github template #4008

Merged
merged 1 commit into from
Apr 23, 2024
Merged
Changes from all commits
Commits
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
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)
Loading