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

chore: port GitHub issue form from Webkit #793

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

nschonni
Copy link
Contributor

@nschonni nschonni commented Apr 29, 2023

The WebKit repo moved over to the the new issue template. I took a quick pass at porting their template, but feel free to push any more changes

You can see the rough render by looking at the file https://github.com/mozilla/standards-positions/blob/8a56a4958769ddbbd0c6a36c440319871322526f/.github/ISSUE_TEMPLATE/request-for-position.yml

@zcorpan
Copy link
Member

zcorpan commented May 24, 2023

@bgrins are there any scripts or so that would need updates for this change?

@bgrins
Copy link
Member

bgrins commented May 24, 2023

The only thing I can think of is this script which was used to seed a project and to keep a combined position file (combining activities.json and labeled issues). If we want that CSV to stay updated we'd need to change the script to look for both the old and new text for each field but I don't mind doing that.

Copy link
Member

@tantek tantek left a comment

Choose a reason for hiding this comment

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

s/@dbaron//

Copy link
Member

@tantek tantek left a comment

Choose a reason for hiding this comment

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

In reviewing the changes to CONTRIBUTING.md and the deletion of ISSUE_TEMPLATE.md in particular, this change is a UX regression (how folks, especially developers filing issues, interact with standards-positions) in a couple of ways that I'd like to see fixed before landing this:

  1. The custom link for "open a new issue" in CONTRIBUTING.md belies the fact that it's perfectly reasonable (more likely) for someone to come to the repo, click Issues, and click New issue, than be burdened with hunting through CONTRIBUTING.md every time for one specific text link embedded in prose. Expected behavior: using GitHub UI to click "New issue" should "just work".
  2. Currently developers can post a new issue via the GitHub API as noted in CONTRIBUTING.md. I’ve done this myself and it works great. Removing that is a regression.

Thus the requested fixes are:

  1. Restore ISSUE_TEMPLATE.md
  2. Update it statically with the fields from the new issue form
  3. Restore the text/links in CONTRIBUTING.md regarding "(If posting via GitHub API, please copy the template and fill it out)." We should continue to support this use-case.

@nschonni
Copy link
Contributor Author

You don't need to use the special link, when clicking on new, you get the template chooser as seen on the WebKit repo
image

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.

4 participants