name: Write an improvement proposal specification
description: Propose an improvement with a high level of detail.
body:

  - type: markdown
    attributes:
      value: |
        - Choose a descriptive title above that differentiates your proposal from other, similar proposals.

        ### Before you start
        - Review the [Rules for submitting a proposal](https://github.com/godotengine/godot-proposals?tab=readme-ov-file#rules-for-submitting-a-proposal). If you fail to comply with them, the proposal will be closed.
        - Search [existing proposals](https://github.com/godotengine/godot-proposals/issues?q=is%3Aissue) for related or duplicate proposals.
        - Search the internet and [asset library](https://godotengine.org/asset-library/asset) for assets that could solve your problem without an engine change.

  - type: textarea
    attributes:
      label: Problem or limitation
      description: |+
        Describe the problem or limitation you are facing while working on your project.
        Give context to your problem.
        To give an example in cooking: Say you wanted to bake a cake and found a recipe.
        Don't write your problem as "I need flour", write "I want to bake a cake".
        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: |+
        <Example>
        The 3D selection tools are cumbersome to use.
        [more text here...]
    validations:
      required: true

  - type: textarea
    attributes:
      label: Proposed improvement
      description: |+
        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
        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.
        If your solution lacks in detail, is ambiguous, or otherwise unactionable, your proposal will be closed.
      placeholder: |+
        <Example>
        Add keyboard shortcuts to select groups of nodes quickly.
        When the user presses Ctrl + Shift + G, select all nodes that have the group...
        [more text here...]
    validations:
      required: true

  - type: checkboxes
    id: actionable
    attributes:
      label: Proposal review
      description: |+
        Please ask yourself honestly: Is your description above specific enough for contributors to implement this improvement without improvising the details?
        If not, consider creating a [discussion](https://github.com/godotengine/godot-proposals/discussions) instead.
        Repeatedly posting unactionable or low-effort proposals may lead to restrictions on your ability to post new proposals.
      options:
        - label: Yes, this proposal is highly specific and actionable.
          required: true