From b65c7c437a952fa37747659ae60d3142508b280e Mon Sep 17 00:00:00 2001 From: Kevin Zheng Date: Sun, 22 Oct 2023 21:08:40 -0700 Subject: [PATCH] Add feature proposal template --- .../general-development/feature-proposals.md | 8 +++++-- src/en/proposals/proposal-template.md | 24 +++++++++++++++++++ 2 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 src/en/proposals/proposal-template.md diff --git a/src/en/general-development/feature-proposals.md b/src/en/general-development/feature-proposals.md index 5e17ea20c..478b5f0f0 100644 --- a/src/en/general-development/feature-proposals.md +++ b/src/en/general-development/feature-proposals.md @@ -4,9 +4,13 @@ If you are considering adding or reworking some major component of the game it's ## How do I make a proposal? -Just follow [our guide](../meta/guide-to-editing-docs.md) on editing any part of this site and PR your proposal as a page under the "Design Proposals" section found in the sidebar between "Space Station 14" and "Server Hosting". +1. Make a copy of the design proposal template located at `src/en/proposals/proposal-template.md`. -Proposals that get approved by a maintainer will be merged to this site, which is basically the green light for you or someone else to go ahead and implement it. +2. Write your proposal (see [guide to editing docs](../meta/guide-to-editing-docs.md)). + +3. When you are ready for your proposal to be reviewed, make a pull request. + +4. Your proposal is approved when a maintainer merges it. This is a green light for you or someone else to go ahead and implement it. A maintainer will then link your proposal to the side bar. *Note to maintainers: edit `src/SUMMARY.md`* ``` admonish tip "Unfinished Proposals" If you don't think that your proposal is ready for maintainer scrutiny, but still want feedback on it you can PR it as a draft. Drafts are less likely to attract people looking to get down to brass tacks, but still let people comment and give advice. diff --git a/src/en/proposals/proposal-template.md b/src/en/proposals/proposal-template.md new file mode 100644 index 000000000..c22ae575e --- /dev/null +++ b/src/en/proposals/proposal-template.md @@ -0,0 +1,24 @@ +# 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. + +**Authors:** foo, bar + +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 + +## Abstract + +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.