Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions .github/ISSUE_TEMPLATE/submission.yaml
Original file line number Diff line number Diff line change
@@ -1,71 +1,69 @@
---
name: New SDG submission
name: New SDG proposal
description: >-
Provide required information for a Small Development Grant submission.
Provide the required information for a new Small Development Grant proposal.
labels:
- Awaiting approval
body:
- id: instructions
type: markdown
attributes:
value: |+
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No obvious need to specify not normalizing trailing newlines (of which there is only the one anyway)

Follow the indications as required to submit a Small Development Grant submission.
Notice that a project lead has to approve the submission.
> [!CAUTION]
> This is a form for only [sponsored](https://numfocus.org/sponsored-projects) and [affiliated](https://numfocus.org/sponsored-projects/affiliated-projects) NumFOCUS projects
value: |
Complete the below fields to submit a Small Development Grant proposal.
Note that a project lead has to approve the proposal submission.
Comment on lines +12 to +13
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use clearer and more appropriate wording

> [!IMPORTANT]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a more appropriate and less negative admonition type here

> This form is only for NumFOCUS [sponsored](https://numfocus.org/sponsored-projects) and [affiliated](https://numfocus.org/sponsored-projects/affiliated-projects) projects.
> Discuss the proposal with the project leads before submitting this issue.
> Each project has a limit of one proposal per round.
- id: project
type: input
attributes:
label: Project
description: Which project is this proposal for? Comma separate them if this is a collaboration between different projects.
description: "Which NumFOCUS project is this proposal for (comma separate the names if a collaboration between multiple projects)"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was removing the question mark intentional?

validations:
required: true
- id: summary
type: input
attributes:
label: Summary
description: Two-sentece summary
description: "Two-sentence summary of the proposal"
validations:
required: true
- id: submitter
type: input
attributes:
label: submitter
description: Who is submitting this request
placeholder: "First name & Last name"
label: Submitter
description: "Who is submitting this request"
placeholder: "Full name"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Avoid embedding the assumption that the ordering or structure of the submitter's name conforms to Western cultural norms

validations:
required: true
- id: lead
type: input
attributes:
label: project lead
description: "Who is the project lead that can approve this proposal (github username)"
label: Project lead
description: "Who is the project lead that can approve this proposal (GitHub username)"
placeholder: "@github_username"
validations:
required: true
- id: impact
type: textarea
attributes:
label: Community benefit
description: >-
What will be the imapct to the community if this project gets funded
description: "How will this proposal positively impact the community"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simplified and clarified this phrasing to be more direct and less awkward/unidiomatic. Also fixed a typo.

validations:
required: true
- id: amount
type: input
attributes:
label: Amount requested
description: How much money is required to execute this proposal
description: "How much money is required to execute this proposal (max $10k)"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May as well be explict about the limit

placeholder: "1000"
validations:
required: true
- id: plan
type: textarea
attributes:
label: Execution plan
description: >-
"Who will implement this, what's the timeline, how will it be done"
description: "Who will implement this, what's the timeline, and how will it be carried out"
Comment on lines -68 to +67
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes the spurious quotes in the block scalar here being unintentionally displayed in the output

validations:
required: true