Skip to content

Commit

Permalink
Added Github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
alice-i-cecile committed Mar 31, 2021
1 parent 2ec2ea4 commit 6e6308c
Show file tree
Hide file tree
Showing 6 changed files with 107 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug Report
about: Report a bug to help us improve!
title: ''
labels: bug
assignees: ''
---

## Fonts of Power version

The release number or commit hash of the version you're using.

## Operating system & version

Ex: Windows 10, Ubuntu 18.04, iOS 14.

## What you did

The steps you took to uncover this bug.
Please list full reproduction steps if feasible.

## What you expected to happen

What you think should've happened if everything was working properly.

## What actually happened

The actual result of the actions you described.

## Additional information

Any additional information you would like to add such as screenshots, logs, etc.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/content_idea.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Content Idea
about: Share your cool idea for a post!
title: ''
labels: content
assignees: ''
---

## Name

What's your working title and subtitle?

## Notes

Any quick notes on the idea.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Docs Improvement
about: Help us write better docs to catch common issues!
title: ''
labels: documentation
assignees: ''
---

## What problem did the developer encounter?

Briefly describe the problem the developer encountered. Links are welcome.

## What was the fix?

Describe the solution that was suggested to fix their problem or the explanation that was given.

## How could this be better documented?

Point to docs that were incomplete or misleading.
If you have suggestions on exactly what the new docs should say, feel free to include it here.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/usability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Usability Friction
about: Help us polish the user experience!
title: ''
labels: polish
assignees: ''
---

## Which feature is frustrating to use or confusing?

The rule or interaction in the video game that creates friction.

## Expectation

How do you intuitively expect the rule or interaction to behave?
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: Blog Post
about: Yet another piece of *content*
title: ''
labels: content
assignees: ''
---
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/rfc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Request for Comments
about: Create a central point for discussion of particularly complex concepts
title: ''
labels: rfc
assignees: ''
---

RFCs are used to collaboratively refine particularly complex designs in a scalable fashion before work begins.

For *Leafwing Studios,* the RFC process is pretty straightforward:

1. Copy the `docs/src/rfc/archived/000-rfc-template.md` file into a new file in the `active` subfolder.
2. Choose a descriptive feature name and the next available RFC number, and update the template and file name.
3. Reference any related issues / work in this PR's thread to ensure proper linking.
4. Refine the RFC until the team is ready to begin implementation.
5. To reduce overhead, follow-up work should be done as part of the same PR if possible.
6. Once the RFC is complete, move it from active to archived.

0 comments on commit 6e6308c

Please sign in to comment.