Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Github issue template forms #477

Merged
merged 1 commit into from Dec 12, 2023
Merged

Conversation

simonjbeaumont
Copy link
Collaborator

Motivation

Github recently added support for Issue forms, which can help guide the creation of issues for adopters and developers to provide the critical information needed to diagnose issues. These have recently been adopted by the Swift project too, from which our templates take much inspiration.

When using issue forms (and templates in general) it also provides the filer with a choice of what kind of issue it is, and can automatically add appropriate labels based on kind and apply the status/triage label.

Finally the page that displays the choice of issue templates can be further extended to provide links to other useful external resources.

Note that it is still possible to create an issue from a blank slate if none of the options suit the adopter.

Check out the "New issue" page on apple/swift to see all these features combined and in action1.

Modifications

  • Add template for reporting a bug:
    • Disclaimer that this is not for Xcode issues.
    • Required fields for versions, reproduction steps, expected behavior.
    • Optional fields for additional information.
    • Applies labels: kind/bug, status/triage.
  • Add template for asking a question:
    • Disclaimer that this is not for Xcode support.
    • Links to FAQ.
    • Applies labels: kind/support, status/triage.
  • Add template for requesting a feature:
    • Explains the proposal process.
    • Required fields for cut-down proposal input.
    • Applies labels: kind/feature, status/triage.
  • Add template for tracking a task:
    • Meant for maintainers and for breaking out issues from PRs or quotes from bugs.
    • Applies labels: kind/enhancement, status/triage.
  • Added additional resources to chooser:
    • Documentation
    • Examples
    • FAQ
    • Supported OpenAPI features
    • Proposal process
    • Swift Open Source Slack channel
    • Feedback Assistant for Xcode and URLSession bugs
  • Kept the blank issues enabled.

Result

More guided process when filing issues and surfaces other relevant resources.

Test Plan

None.

Footnotes

  1. https://github.com/apple/swift/issues/new/choose

@simonjbeaumont simonjbeaumont force-pushed the sb/issue-forms branch 4 times, most recently from cf5f224 to b215af4 Compare December 11, 2023 22:54
Copy link
Collaborator

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

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

A few suggestions, otherwise lgtm!

.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/support-request.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/support-request.yml Outdated Show resolved Hide resolved
@czechboy0
Copy link
Collaborator

:shipit:

@czechboy0 czechboy0 merged commit 2e0aa5f into apple:main Dec 12, 2023
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants