Skip to content

Commit d1d06c6

Browse files
Refining workflows
* Updated instructions * Updated the submission instructions to clean up the original issue
1 parent 4e2d297 commit d1d06c6

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

.github/instructions/wants-processing.instructions.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Follow these detailed instructions when processing Want submissions for the Web
1010
- `submitter`: Submitter's name or "Anonymous"
1111
- `number`: Submission ID from issue
1212
- `tags`: Array of relevant technology labels
13-
- `discussion`: GitHub discussions URL using issue ID
13+
- `discussion`: GitHub discussions URL ending with the original issue number (e.g. `https://github.com/WebWeWant/webwewant.fyi/discussions/<issue-number>`)
1414
- `status`: "discussing"
1515

1616
### Optional Fields
@@ -145,7 +145,7 @@ npm run check-duplicate "Want Title From Issue"
145145
- `submitter`: Use provided name or "Anonymous" if privacy requested
146146
- `number`: Use the generated UUID
147147
- `tags`: Add 1-3 relevant technology labels (see tag list below)
148-
- `discussion`: Use GitHub discussions URL with issue ID
148+
- `discussion`: Use GitHub discussions URL whose trailing ID matches the original issue number
149149
- `status`: Set to "discussing"
150150
- Content: Clean up and enhance the description for clarity
151151

@@ -157,12 +157,17 @@ npm run check-duplicate "Want Title From Issue"
157157
type: spec
158158
```
159159
160-
4. **Validate the file:**
160+
4. **Update the original issue body** to match the polished want content:
161+
- Remove any frontmatter or submission metadata that came from the form
162+
- Replace the issue description with the cleaned narrative used in the want markdown (no YAML blocks)
163+
- Confirm the issue title remains accurate so conversion to a discussion keeps the right context
164+
165+
5. **Validate the file:**
161166
```bash
162167
npm run validate-want wants/<ID>.md
163168
```
164169

165-
5. **Create pull request:**
170+
6. **Create pull request:**
166171
- Branch: `submission/<descriptive-name>`
167172
- Title: "Add want: [Want Title]"
168173
- Include issue number in PR description
@@ -292,7 +297,7 @@ Before creating the want file, verify:
292297
- **Single source of truth:** These instructions are your only guidance - don't reference other documentation
293298
- **Act decisively:** Process submissions quickly but thoroughly
294299
- **Maintain quality:** Enhance content for clarity while preserving submitter intent
295-
- **Preserve context:** Always reference the original issue number in PRs
300+
- **Preserve context:** Always reference the original issue number in PRs and ensure discussion URLs end with that number
296301
- **Human escalation:** When in doubt, flag for human review rather than rejecting
297302

298303
**Efficiency:**

.github/workflows/process-submission.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,12 @@ jobs:
5252
**Follow ALL instructions in \`.github/instructions/wants-processing.instructions.md\` section "Step 5: Want File Creation" - this is your ONLY source of truth.**
5353
5454
Key steps:
55-
1. Run \`npm run create-want\` to generate UUID and markdown template
56-
2. Fill in the markdown file with data from this issue
57-
3. Run \`npm run validate-want wants/<UUID>.md\` to validate
58-
4. Create branch and PR with markdown file
59-
5. Reference this issue number in the PR description
55+
1. Run \`npm run create-want\` to generate UUID and markdown template
56+
2. Fill in the markdown file with data from this issue (ensure the discussion URL ends with this issue number)
57+
3. Add any related links and update the original issue body to match the cleaned want content (no frontmatter)
58+
4. Run \`npm run validate-want wants/<UUID>.md\` to validate
59+
5. Create branch and PR with markdown file
60+
6. Reference this issue number in the PR description
6061
6162
Do not look at any other documentation files for processing guidance.`;
6263

0 commit comments

Comments
 (0)