mirror of
https://github.com/godotengine/godot-proposals.git
synced 2026-09-03 18:14:03 +03:00
Re-write the problem rule to be about context rather than effort.
This commit is contained in:
13
.github/ISSUE_TEMPLATE/feature_proposal.yml
vendored
13
.github/ISSUE_TEMPLATE/feature_proposal.yml
vendored
@@ -17,10 +17,12 @@ body:
|
|||||||
label: Problem or limitation
|
label: Problem or limitation
|
||||||
description: |+
|
description: |+
|
||||||
Describe the problem or limitation you are facing while working on your project.
|
Describe the problem or limitation you are facing while working on your project.
|
||||||
It is not enough to say a feature would be "nice" or "helpful".
|
Give context to your problem.
|
||||||
Describe how the lack of it is impacting your ability to make games.
|
To give an example in cooking: Say you wanted to bake a cake and found a recipe.
|
||||||
You should also describe which workarounds you tried and link related proposals. If you do
|
Don't write your problem as "I need flour", write "I want to bake a cake".
|
||||||
not provide a well-founded motivation, your proposal will be closed.
|
To add flour is the proposed solution.
|
||||||
|
You should also describe which workarounds you tried and link related proposals.
|
||||||
|
If you do not provide a well-founded motivation, your proposal will be closed.
|
||||||
placeholder: |+
|
placeholder: |+
|
||||||
<Example>
|
<Example>
|
||||||
The 3D selection tools are cumbersome to use.
|
The 3D selection tools are cumbersome to use.
|
||||||
@@ -33,10 +35,11 @@ body:
|
|||||||
label: Proposed improvement
|
label: Proposed improvement
|
||||||
description: |+
|
description: |+
|
||||||
Describe how to overcome the limitation you described above.
|
Describe how to overcome the limitation you described above.
|
||||||
|
Be specific with your solution.
|
||||||
It is not enough to describe just the idea; your proposal should make all the necessary design decisions
|
It is not enough to describe just the idea; your proposal should make all the necessary design decisions
|
||||||
such that they can be discussed by the community. Include images, mock-ups, diagrams, code, if applicable.
|
such that they can be discussed by the community. Include images, mock-ups, diagrams, code, if applicable.
|
||||||
Also consider describing the positive impact your proposal could have.
|
Also consider describing the positive impact your proposal could have.
|
||||||
If your solution lacks in detail, is ambiguous, or otherwise low-effort, your proposal will be closed.
|
If your solution lacks in detail, is ambiguous, or otherwise unactionable, your proposal will be closed.
|
||||||
placeholder: |+
|
placeholder: |+
|
||||||
<Example>
|
<Example>
|
||||||
Add keyboard shortcuts to select groups of nodes quickly.
|
Add keyboard shortcuts to select groups of nodes quickly.
|
||||||
|
|||||||
11
README.md
11
README.md
@@ -57,15 +57,16 @@ AI-written proposals are hard to read and often invent facts and solutions that
|
|||||||
If you aren't comfortable with English, write your proposal in your mother tongue and use
|
If you aren't comfortable with English, write your proposal in your mother tongue and use
|
||||||
dedicated translation software (not a chat bot) to translate it into English.
|
dedicated translation software (not a chat bot) to translate it into English.
|
||||||
|
|
||||||
3. **Put effort into the problem statement.** It is not enough to say a feature would be
|
3. **Give context to your problem.** To give an example in cooking: Say you wanted to bake
|
||||||
"nice" or "helpful". Describe how the lack of it is impacting your ability to make games.
|
a cake and found a recipe. Don't write your problem as "I need flour", write "I want to bake
|
||||||
You should also describe which workarounds you tried and link related proposals. If you do
|
a cake". To add flour is the proposed solution. You should also describe which workarounds
|
||||||
not provide a well-founded motivation, your proposal will be closed.
|
you tried and link related proposals. If you do not provide a well-founded motivation, your
|
||||||
|
proposal will be closed.
|
||||||
|
|
||||||
4. **Be specific with your solution.** It is not enough to describe just the idea; your proposal
|
4. **Be specific with your solution.** It is not enough to describe just the idea; your proposal
|
||||||
should make all the necessary design decisions such that they can be discussed by the community.
|
should make all the necessary design decisions such that they can be discussed by the community.
|
||||||
Include images, mock-ups, diagrams, code, if applicable. If your solution lacks in detail,
|
Include images, mock-ups, diagrams, code, if applicable. If your solution lacks in detail,
|
||||||
is ambiguous, or otherwise low-effort, your proposal will be closed.
|
is ambiguous, or otherwise unactionable, your proposal will be closed.
|
||||||
|
|
||||||
5. **Use one issue per proposal.** Do not cram multiple feature requests into a single proposal,
|
5. **Use one issue per proposal.** Do not cram multiple feature requests into a single proposal,
|
||||||
as this makes it harder to discuss features individually.
|
as this makes it harder to discuss features individually.
|
||||||
|
|||||||
Reference in New Issue
Block a user