Skip to content

feat: Add process templates for GitHub issues #293

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

Merged
merged 7 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
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
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/3-story_task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Story task
about: This template is for a story or task, encompassing a single work item for completion
title: ""
labels: "documentation"
projects: ["nginxinc/32"]
assignees: ""
---

*Remove italicized directions as relevant to reduce noise in the issue description.*

## Overview

*Written as a user story*.

**As a** <user>, **I want** <thing>, **So I can** <action>.

## Description

*Add the finer details of what this task involves and is trying to accomplish. A problem well defined is half-solved*.

## Acceptance criteria

*Add any exacting acceptance criteria for the task to be complete. Start with known hard requirements, since they may create blockers.*
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/4-epic_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Epic overview
about: This template is for planning an epic, which is a large body of effort involving multiple stories or tasks
title: ""
labels: "epic, documentation"
projects: ["nginxinc/32"]
assignees: ""
---

*Remove italicized directions as relevant to reduce noise in the issue description.*

## Description

*Write a high-level description of what the body of work for this epic includes.*

## Goals

*Describe the intent of the epic and what the intended impact is for this effort.*

## User stories

*Add a user story for relevant persona to this epic, who are the stakeholders*.

**As a** <user>,
**I want** <thing>,
**So I can** <action>.

**As a** <user>,
**I want** <thing>,
**So I can** <action>.

## Tasks

*Create a simple list of tasks necessary for this epic. Finer details should be kept to sub-issues/tasks/stories.*

- Example task 1
- Example task 1
- Example task 1
- Example task 1
- Example task 1
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/5-content_plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Content release plan
about: This template is for a content release plan, typically tied to a product release
title: " v#.# content release plan"
labels: "documentation"
projects: ["nginxinc/32"]
assignees: ""
---

*Remove italicized directions as relevant to reduce noise in the issue description.*

## Overview

- **Product name**:
- **Release date**:

A content release plan establishes and tracks the documentation work for a product related to a release.

Add tickets to this content release plan as sub-issues, and update it as you go along.

## Description

*Write a high-level summary of changes expected in this release*.

## User stories

**As a** technical writer,
**I want** a content release plan for my product,
**So I can** ensure correct content is released alongside the latest version of the product.

**As a** product owner,
**I want** a content release plan for my product,
**So I can** ensure the product team includes documentation as part of changes to the product.

## Tasks

*Create a simple list of tasks necessary for this content plan. Finer details can be kept to sub-issues.*
*Each task item should have a 1:1 relationship with a documentation item, which could be an engineering issue.*

- [ ] Update changelog/release notes
- [ ] Update version reference information (Such as technical specifications, version shortcodes)
- [ ] Update any other documentation impacted by changes in this release
- Additional task 1
- Additional task 2