Skip to content

Conversation

@stmontgomery
Copy link
Contributor

This includes several improvements to this project's GitHub Issue templates.

Motivation:

Some of these changes are meant to guide users to provide more useful information when filing issues, or point them to other places when appropriate. Other changes are meant to help contributors and maintainers better organize issues in the project.

Modifications:

  • Add a config.yml to add several related links in the New Issue template chooser to related places like the our Forums category, the bug report links for related tools, and documentation.
  • Modify the "Bug Report" template:
    • Rename it to "Report a bug" and clarify its description.
    • Modify its fields to more clearly explain each question and consolidate some.
  • Modify the "Feature Request" template:
    • Rename it to "Request a change" and clarify its description.
    • Modify fields to be more relevant to a change request.
  • Add a "Task" template.
  • Added a (newly created) triage-needed label to the "Bug Report" and "Request a Change" templates so we can distinguish those which have not yet been triaged.
  • Add notes to the top of several templates about how they're not meant for Xcode feedback, and directing major ideas to the Forums instead.
  • Add copyright header to all template-related files.
  • Add numbers to the template files to control their display order.
  • Switch to kebab-case file names for the templates.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

@stmontgomery stmontgomery added documentation 📚 Improvements or additions to documentation enhancement New feature or request labels Feb 17, 2025
@stmontgomery stmontgomery added this to the Swift 6.x milestone Feb 17, 2025
@stmontgomery stmontgomery self-assigned this Feb 17, 2025
Copy link
Contributor

@grynspan grynspan left a comment

Choose a reason for hiding this comment

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

Fine with me!

@stmontgomery stmontgomery merged commit 47cacd2 into swiftlang:main Feb 17, 2025
@stmontgomery stmontgomery deleted the issue-template-improvements branch February 17, 2025 17:58
stmontgomery added a commit that referenced this pull request May 22, 2025
This removes the `triage-needed` label from the GitHub New Issue
templates in this repository which have it.

I added this while revamping these templates in #962, but more recently
we added a `triaged` label which is works the opposite way—it's applied
after an issue has been triaged—so we don't need the older label
anymore.

### Checklist:

- [x] Code and documentation should follow the style of the [Style
Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md).
- [x] If public symbols are renamed or modified, DocC references should
be updated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📚 Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants