Skip to content

Commit

Permalink
docs: improve feature idea template and workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryun1 committed Aug 12, 2024
1 parent 960e7c0 commit 3072c66
Show file tree
Hide file tree
Showing 2 changed files with 152 additions and 17 deletions.
77 changes: 60 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_idea.yml
Original file line number Diff line number Diff line change
@@ -1,44 +1,87 @@
name: Feature idea
name: 💡 Feature idea
description: Idea or request for some feature on the GovTool roadmap
labels: [':thought_balloon: idea']
title: "💡 "
projects: ["IntersectMBO/projects/30", "IntersectMBO/projects/34"]
body:
- type: markdown
attributes:
value:
value: |
**Thank you for contributing to our project!** :green_heart:
## 🌟 **Thank you for contributing to GovTool!**
- type: markdown
attributes:
value: |
Before submitting a new issue consider [starting a new discussion](https://github.com/IntersectMBO/govtool/discussions/new?category=ideas).
Instead of opening this issue, consider [starting a new idea discussion](https://github.com/IntersectMBO/govtool/discussions/new?category=ideas).
That way, we can discuss & refine your idea together, before we adopt it as a feature into the roadmap.
- type: dropdown
id: area
attributes:
label: Area
description: What part of GovTool does this feature affect?
options:
- Proposal Pillar
- Voting Pillar
- Delegation Pillar
- Wrapper
- Other
- Not sure
validations:
required: true

- type: textarea
id: why
- type: dropdown
id: design-needed
attributes:
label: Why
description: Why do we need or want this feature
placeholder: |
Give context and describe the problem, challenge or opportunity you see
label: Is there new design needed?
description: Will this feature require new or edit to existing frontend designs?
options:
- 'Yes'
- 'No'
- Not sure
validations:
required: true

- type: textarea
id: what
attributes:
label: What
description: What is this feature roughly about
label: What?
description: What is this feature?
placeholder: |
For example describe a new API endpoint, a change in messaging formats,
For example describe a new API endpoint, a change in wording,
a new configuration option, ...
validations:
required: true

- type: textarea
id: why
attributes:
label: Why?
description: Why do we need or want this feature?
placeholder: |
Give context and describe the problem the idea solves
validations:
required: true

- type: textarea
id: how
attributes:
label: How
description: How could we realize this feature
label: How?
description: How can we realize this feature?
placeholder: |
Which technical solutions, libraries or systems should be used, which
components need to change, steps how to implement this, ...
validations:
required: true

- type: markdown
attributes:
value: |
---
- type: textarea
id: user-story
attributes:
label: (Optional) User Story with acceptance criteria
description: See GovTool examples [here](https://github.com/IntersectMBO/cardano-test-plans/blob/main/userStoryInventoryChangHF.md#2g-delegate-to-self-for-registered-dreps).
placeholder: |
As a [ada holder | DRep | Direct voter], I want [some goal] so that [some reason].
validations:
required: false
92 changes: 92 additions & 0 deletions .github/workflows/label-feature-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Add labels to 💡 Feature idea issues

on:
issues:
types: [opened, edited]

permissions:
issues: write
contents: read

jobs:
apply-labels:
runs-on: ubuntu-latest
steps:
- name: Check if issue is a "💡 Feature idea"
id: check_is_feature_idea
run: |
echo "## Checking if issue is a 'Feature idea'..."
if [[ "${{ github.event.issue.title }}" == "💡 "* ]]; then
echo "is_feature_idea=true" >> $GITHUB_ENV
else
echo "is_feature_idea=false" >> $GITHUB_ENV
fi
- name: Apply label based on feature area
if: ${{ env.is_feature_idea == 'true' }}
uses: actions/github-script@v6
with:
script: |
const areaMap = {
"Proposal Pillar": "📜 Proposal Pillar",
"Voting Pillar": "🗳️ Voting Pillar",
"Delegation Pillar": "♟️ Delegation Pillar",
"Wrapper": "🎁 Wrapper",
"Other": "Other area",
"Not sure": "❓Unknown area",
};
const issueBody = context.payload.issue.body;
// Match the Area selected under the "### Area" header
const areaMatch = issueBody.match(/### Area\s*\n\s*(.*)\s*\n/);
const area = areaMatch ? areaMatch[1].trim() : null;
const labelToAdd = areaMap[area];
if (labelToAdd) {
await github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: [labelToAdd],
});
}
- name: Apply "🎨 Design Needed" label if design needed is "Yes"
if: ${{ env.is_feature_idea == 'true' }}
uses: actions/github-script@v6
with:
script: |
const issueBody = context.payload.issue.body;
// Match the "Yes" selection under the "### Is there new design needed?" header
const designNeededMatch = issueBody.match(/### Is there new design needed\?\s*\n\s*Yes\s*\n/);
if (designNeededMatch) {
await github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ["🎨 Design Needed"],
});
}
- name: Apply "User Story Needed" label if user story not provided
if: ${{ env.is_feature_idea == 'true' }}
uses: actions/github-script@v6
with:
script: |
const issueBody = context.payload.issue.body;
const userStoryPattern = /### \(Optional\) User Story with acceptance criteria\s*\n\s*_No response_/;
const userStoryMissing = userStoryPattern.test(issueBody);
if (userStoryMissing) {
await github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ["User Story Needed"],
});
}

0 comments on commit 3072c66

Please sign in to comment.