Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlgo11 committed Nov 13, 2023
1 parent c34ce2c commit d576db2
Show file tree
Hide file tree
Showing 9 changed files with 110 additions and 116 deletions.
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/01-add-passkeys-entry.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: 🔒 Add site with passkey support
description: Request that a site that supports passkey authentication be added.
title: Add [site name]
labels: add site
body:

- type: markdown
attributes:
value: |
## Thank you for contributing to this project!
Our site depends on user contributions to stay up to date. If you know how to write JSON files, we prefer you create a [pull request](https://github.com/2factorauth/passkeys/blob/master/CONTRIBUTING.md) instead of an issue.
Please take time to fill out as much as possible in this form. We receive a lot of issues, and your thoroughness helps speed things up.
If you cannot fill a field out, leave it blank and let us know why in the "Additional information" section.
- type: input
id: name
attributes:
label: Site name
description: Official name of the site
placeholder: YouTube
validations:
required: true

- type: input
id: url
attributes:
label: Site URL
description: Link to the main page
placeholder: https://youtube.com
validations:
required: true

- type: input
id: doc
attributes:
label: Documentation URL
description: |
Link to documentation on how to enable passkey authentication on the site.
Attach screenshots of the setup/login process if no public-facing documentation link is available, redacting any personal information.
- type: input
id: recovery
attributes:
label: Recovery Documentation URL
description: |
People sometimes lose their phones or security keys. If the site offers a way to recover an account in such an event, please link to a page describing how to recover an account.
If the site doesn't provide such an option or has no public-facing documentation, leave this field blank.
- type: checkboxes
id: 2fa
attributes:
label: Supported options
description: Check every passkey authentication method that the site supports.
options:
- label: Passwordless authentication
- label: Passkey as MFA

- type: textarea
id: regions
attributes:
label: Regions served
description: |
Some sites have a limited market. If the site is only intended for users in certain countries or regions, please list those countries/regions below.
For sites that technically are available globally but only of interest to a single region, please list the region.
If the primary audience is residents in a larger region, like North America or Europe, you can list that region instead of each country.
- type: checkboxes
id: eligibility
attributes:
label: Eligibility
description: |
Check each box below to verify that the site meets our requirements for being listed.
You can still create an issue even if a site does not meet these requirements.
Leave any unmet requirements unchecked, and provide any additional information or questions in the "Additional information" section below.
options:
- label: I have checked that the site meets the Passkey Directory's [site eligibility criteria](https://github.com/2factorauth/passkeys/blob/master/CONTRIBUTING.md)
- label: The site is ranked within the top 200,000 global sites on [Similarweb](https://www.similarweb.com/).
- label: The issue I'm creating is not a duplicate of an existing [issue](https://github.com/2factorauth/passkeys/issues) or [pull request](https://github.com/2factorauth/passkeys/pulls).
required: true

- type: textarea
id: extra
attributes:
label: Additional information
description: If you have any additional information, please provide it here.
93 changes: 0 additions & 93 deletions .github/ISSUE_TEMPLATE/01-add-site-with-2fa.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 🔓 Add site without 2FA
name: 🔓 Add site without passkey support
description: Request that a site that does not support 2FA be added.
title: Add [site name]
labels: add site
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ body:
required: true

- type: dropdown
id: 2fa
id: reason
attributes:
label: Update reason
description: "This site entry should be updated because:"
multiple: true
options:
- It now supports 2FA.
- It now supports passkey authentication.
- Its name has changed.
- Its logo has changed.
- It no longer supports 2FA.
- It no longer supports passkey authentication.
- Its documentation link has changed.
- It fits better in a different category.
- The methods of 2FA that it supports have changed.
- The methods of passkey authentication that it supports have changed.
- Its Twitter username, Facebook page, and/or email address have changed.
- It has been acquired or absorbed by another site, and the new site is eligible to be listed on 2fa.directory.
- It has been acquired or absorbed by another site, and the new site is eligible to be listed in the Passkeys Directory.
- Other (please describe below).
validations:
required: true
Expand All @@ -47,17 +47,17 @@ body:
description: |
### List the specific changes to the site entry that should be made below.
For example, if a site now supports 2FA, list the methods of 2FA the site now supports.
Please include any supporting documentation for the changes as well, such as official documentation links or announcement blog posts.
If no public-facing documentation is available, please include screenshots of the changes, redacting any personal information.
For example, if a site now supports passkey authentication, list the methods of passkey authentication the site now supports.
Please include any supporting documentation for the changes, such as official documentation links or announcement blog posts.
If no public-facing documentation is available, please include screenshots of the changes redacting any personal information.
- type: checkboxes
attributes:
label: Issue Eligibility
description: |
Check each box below to verify that this issue meets our requirements.
options:
- label: The issue I'm creating is not a duplicate of an existing [issue](https://github.com/2factorauth/twofactorauth/issues).
- label: The issue I'm creating is not a duplicate of an existing [issue](https://github.com/2factorauth/passkeys/issues).
required: true
- label: The issue I'm creating is not a duplicate of an existing [pull request](https://github.com/2factorauth/twofactorauth/pulls)
- label: The issue I'm creating is not a duplicate of an existing [pull request](https://github.com/2factorauth/passkeys/pulls)
required: true
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ body:
required: true

- type: dropdown
id: 2fa
id: reason
attributes:
label: Removal reason
description: "This site entry should be removed because:"
Expand All @@ -31,9 +31,9 @@ body:
- It is a duplicate of an existing site entry.
- It will be discontinued in the near future.
- It has been shut down by the owner and is no longer accessible.
- It no longer meets 2fa.directory's contributing guidelines and site criteria.
- It contains content that violates 2fa.directory's excluded categories and websites guidelines.
- It has been acquired or absorbed by another site, and the new site is already listed on 2fa.directory.
- It no longer meets the Passkeys Directory's eligibility criteria.
- It contains content that violates the Passkeys Directory's excluded categories and websites guidelines.
- It has been acquired or absorbed by another site, and the new site is already listed in the Passkeys Directory.
- It no longer has verifiable 2FA documentation and is no longer ranked within the top 200,000 global sites on Similarweb.
- Other (please describe below).
validations:
Expand All @@ -51,7 +51,7 @@ body:
description: |
Check each box below to verify that this issue meets our requirements.
options:
- label: The issue I'm creating is not a duplicate of an existing [issue](https://github.com/2factorauth/twofactorauth/issues).
- label: The issue I'm creating is not a duplicate of an existing [issue](https://github.com/2factorauth/passkeys/issues).
required: true
- label: The issue I'm creating is not a duplicate of an existing [pull request](https://github.com/2factorauth/twofactorauth/pulls)
- label: The issue I'm creating is not a duplicate of an existing [pull request](https://github.com/2factorauth/passkeys/pulls)
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/05-request-a-feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In Markdown, checkboxes work like this:
Check the box below before submitting your issue to verify that you have already checked for duplicate open issues and pull requests relating to your request. -->

- [ ] I have searched [open issues and pull requests](https://github.com/2factorauth/twofactorauth/issues?q=is%3Aopen). The issue I'm creating is not a duplicate of an existing open issue or pull request.
- [ ] I have searched [open issues and pull requests](https://github.com/2factorauth/passkeys/issues?q=is%3Aopen). The issue I'm creating is not a duplicate of an existing open issue or pull request.

### Information about the feature to be added: ###
<!-- Please describe the feature you'd like added to the site. How does it function? What's its purpose? -->
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/06-report-a-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ In Markdown, checkboxes work like this:
Check the box below before submitting your issue to verify that you have already checked for duplicate open issues and pull requests relating to your report. -->

- [ ] I have searched [open issues and pull requests](https://github.com/2factorauth/twofactorauth/issues?q=is%3Aopen). The issue I'm creating is not a duplicate of an existing open issue or pull request.
- [ ] I have searched [open issues and pull requests](https://github.com/2factorauth/passkeys/issues?q=is%3Aopen). The issue I'm creating is not a duplicate of an existing open issue or pull request.

### Information about the bug: ###
**Bug description:**
<!-- Provide a brief description of the bug. What's going wrong?
If applicable, also provide screenshots of the bug in action, redacting any personal information. -->
<!-- Provide a brief description of the bug. Do you know what's going wrong?
If applicable, provide screenshots of the bug redacting any personal information. -->


**Bug reproduction:**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: 🤔 Open an issue for something else
name: 🤔 Open an issue about something else
about: Don't see what you're looking for? Create an issue without a template.
title: ''
labels: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 🚨 Report a code of conduct violation
url: https://github.com/2factorauth/twofactorauth/blob/master/CODE_OF_CONDUCT.md#enforcement
url: https://github.com/2factorauth/.github/blob/master/CODE_OF_CONDUCT.md
about: Review the enforcement section of our code of conduct to report a violation.

0 comments on commit d576db2

Please sign in to comment.