Issue forms/templates

[benjyw]

For:

• Bug reports
• Feature requests
• Adding a company to a public list of users

The driving goal was the user registration template, but it made it a bit weird, when opening a new issue, to have a template for that and not for bugs and feature requests. The user would have to click on a small "open a blank issue" link to actually file a normal issue. So this change also includes the bug and feature templates. Those are purposely simple though, and based on GitHub's suggested templates. No need to make bug/feature reporters jump through form hoops.

[ci skip-rust]

[ci skip-build-wheels]

[benjyw]

Template chooser renders as:

[benjyw]

User registration form renders as:

[benjyw]

Bug report renders as:

[benjyw]

Feature request renders as:

[Eric-Arellano]

Awesome!

[cczona]

For the user registration form, I suggest emphasizing that the email address is not for publication on the website. Also, "registration" typically refers to things like registering for warranty support or other customer support. So I wonder if that title would be dismissed as "I don't need this", rather than "Sure, I'll help support Pants by doing this". What if the title is something like "Support the project: add your company to user.pantsbuild.org"?

[cczona]

I like that you included the docs and Slack. Might as well also add the blog, twitter feed, and YouTube channel.

https://www.youtube.com/channel/UCCcfCbDqtqlCkFEuENsHlbQ

[benjyw]

I like that you included the docs and Slack. Might as well also add the blog, twitter feed, and YouTube channel.

https://www.youtube.com/channel/UCCcfCbDqtqlCkFEuENsHlbQ

I'd rather not, because those aren't really places for getting help, which is what the focus is on here. And since the "template chooser" is already quite busy, I think we should keep it to just the highest value things.

[benjyw]

For the user registration form, I suggest emphasizing that the email address is not for publication on the website. Also, "registration" typically refers to things like registering for warranty support or other customer support. So I wonder if that title would be dismissed as "I don't need this", rather than "Sure, I'll help support Pants by doing this". What if the title is something like "Support the project: add your company to user.pantsbuild.org"?

Changed the text relating to the email address to emphasize this.

Changed the title to "Support Pants - List My Company on pantsbuild.org". The description and other text already references the Pants Users list.

[stuhood]

Thanks!

[benjyw]

User form now renders as:

[cczona]

For the user registration form, the main purpose is to validate that the submitter is affiliated with the organization they're adding. Contacting them with questions can typically be done via the issue itself, and in the rare private case taken to DMs or email. (We don't care what address someones uses when discussing questions. Whereas, ensuring that the Who Uses Pants list is accurate is important.)

I propose that instead of asking for email address, we treat the form as Part 1 of 2, with Part 2 being that they send an email (empty is fine) with subject "verify" from their company's domain to an address at pantsbuild.org (verify@pantsbuild.org?) which would be monitored by several Maintainers via Google Groups. The issue would only be approved after a Maintainer has established that the domain for the new listing and the submitter match. Then the Google Group would be available as audit trail if anyone questions the accuracy of a listing.

[Eric-Arellano]

That's similar to how PyPI was doing two-factor authentication restores: you'd email each other before the issue could be closed. It worked well!

[benjyw]

For the user registration form, the main purpose is to validate that the submitter is affiliated with the organization they're adding. Contacting them with questions can typically be done via the issue itself, and in the rare private case taken to DMs or email. (We don't care what address someones uses when discussing questions. Whereas, ensuring that the Who Uses Pants list is accurate is important.)

I propose that instead of asking for email address, we treat the form as Part 1 of 2, with Part 2 being that they send an email (empty is fine) with subject "verify" from their company's domain to an address at pantsbuild.org (verify@pantsbuild.org?) which would be monitored by several Maintainers via Google Groups. The issue would only be approved after a Maintainer has established that the domain for the new listing and the submitter match. Then the Google Group would be available as audit trail if anyone questions the accuracy of a listing.

Yep, see screenshot.