Skip to content

Commit

Permalink
Update proposal.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jezithyr committed Jan 31, 2024
1 parent 4d870ec commit e12e6cd
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions src/en/templates/proposal.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
```admonish info "Proposal"
This page is a proposed feature or rework that hasn't been implemented yet.
```
# Short, Properly Capitalized Title

Your title should convey the basic jist of your proposed changes. It should be short because the text will be linked in the sidebar.

| Designers | Implemented | GitHub Links |
|---|---|---|
| Your Names Here | :white_check_mark: Yes or :warning: Partially or :information_source: Open PR or :x: No | PR Links or TBD |

`Designers` should be the names that you use on GitHub and/or Discord. This is optional but strongly recommended, since:

- This acknowledges credit where it is due
- People who are confused about the written intent can use this information to contact the authors

`Implemented` is the status of the feature.

Github links can include multiple PRs, if relevant.

## Overview

A very short, maybe three sentence summary of what this proposal is about. A high level "overview" or "what this adds".

## Background

Summarize any information that is needed to contextualize the proposed changes, e.g. the current state of the game.

Also link any relevant discussions on Discord, GitHub, or HackMD that are relevant to the proposal.

## The rest?

Is entirely up to you.

0 comments on commit e12e6cd

Please sign in to comment.