From d576db221f351c4d1d26632aad443fca1565cb79 Mon Sep 17 00:00:00 2001 From: Carlgo11 Date: Mon, 13 Nov 2023 17:49:24 +0100 Subject: [PATCH] Update issue templates --- .../ISSUE_TEMPLATE/01-add-passkeys-entry.yml | 87 +++++++++++++++++ .../ISSUE_TEMPLATE/01-add-site-with-2fa.yml | 93 ------------------- ...-2fa.yml => 02-add-non-passkeys-entry.yml} | 2 +- ...-existing-site.yml => 03-update-entry.yml} | 20 ++-- ...-existing-site.yml => 04-remove-entry.yml} | 12 +-- .../ISSUE_TEMPLATE/05-request-a-feature.md | 2 +- .github/ISSUE_TEMPLATE/06-report-a-bug.md | 6 +- .../07-open-an-issue-for-something-else.md | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- 9 files changed, 110 insertions(+), 116 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-add-passkeys-entry.yml delete mode 100644 .github/ISSUE_TEMPLATE/01-add-site-with-2fa.yml rename .github/ISSUE_TEMPLATE/{02-add-site-without-2fa.yml => 02-add-non-passkeys-entry.yml} (98%) rename .github/ISSUE_TEMPLATE/{03-update-existing-site.yml => 03-update-entry.yml} (72%) rename .github/ISSUE_TEMPLATE/{04-remove-existing-site.yml => 04-remove-entry.yml} (81%) diff --git a/.github/ISSUE_TEMPLATE/01-add-passkeys-entry.yml b/.github/ISSUE_TEMPLATE/01-add-passkeys-entry.yml new file mode 100644 index 0000000..3812d18 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-add-passkeys-entry.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/01-add-site-with-2fa.yml b/.github/ISSUE_TEMPLATE/01-add-site-with-2fa.yml deleted file mode 100644 index 3d83964..0000000 --- a/.github/ISSUE_TEMPLATE/01-add-site-with-2fa.yml +++ /dev/null @@ -1,93 +0,0 @@ -name: 🔒 Add site with 2FA -description: Request that a site that supports 2FA 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/twofactorauth/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're not able to 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 2FA 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 phone or security key. If the site offers a way to bypass 2FA 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 there's no public-facing documentation on it, leave this field blank. - - - type: checkboxes - id: 2fa - attributes: - label: Supported 2FA methods - description: Check every 2FA method that the site supports. - options: - - label: TOTP (RFC-6238, Google Authenticator) - - label: Proprietary Software (Authy, Duo, etc.) - - label: U2F/WebAuthn security keys - - label: Proprietary hardware (Yubico OTP, RSA keys, etc.) - - label: Phone calls - - label: SMS tokens - - label: Email tokens - - - 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 for a single region, please list the region. - If the main audience are residents in a larger region, like North America or Europe, you can list that region instead of each individual country. - - - type: checkboxes - id: eligibility - attributes: - label: Eligibility - description: | - Check each box below to verify that the site meets our requirements for being listed. - - Even if a site does not meet all of these requirements you can still create an issue. - 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 2fa.directory's [contributing guidelines and site criteria](https://github.com/2factorauth/twofactorauth/blob/master/CONTRIBUTING.md) - - label: The site is ranked within the top 200,000 global sites on [Similarweb](https://www.similarweb.com/). - - label: The site does not contain or promote content that violates 2fa.directory's [excluded categories and websites guidelines](https://github.com/2factorauth/twofactorauth/blob/master/EXCLUSION.md). - - label: The issue I'm creating is not a duplicate of an existing [issue](https://github.com/2factorauth/twofactorauth/issues) or [pull request](https://github.com/2factorauth/twofactorauth/pulls). - required: true - - - type: textarea - id: extra - attributes: - label: Additional information - description: If you have any additional information to provide, please do so below. diff --git a/.github/ISSUE_TEMPLATE/02-add-site-without-2fa.yml b/.github/ISSUE_TEMPLATE/02-add-non-passkeys-entry.yml similarity index 98% rename from .github/ISSUE_TEMPLATE/02-add-site-without-2fa.yml rename to .github/ISSUE_TEMPLATE/02-add-non-passkeys-entry.yml index 882f9ee..67839a1 100644 --- a/.github/ISSUE_TEMPLATE/02-add-site-without-2fa.yml +++ b/.github/ISSUE_TEMPLATE/02-add-non-passkeys-entry.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/03-update-existing-site.yml b/.github/ISSUE_TEMPLATE/03-update-entry.yml similarity index 72% rename from .github/ISSUE_TEMPLATE/03-update-existing-site.yml rename to .github/ISSUE_TEMPLATE/03-update-entry.yml index 5f3c2da..d754366 100644 --- a/.github/ISSUE_TEMPLATE/03-update-existing-site.yml +++ b/.github/ISSUE_TEMPLATE/03-update-entry.yml @@ -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 @@ -47,9 +47,9 @@ 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: @@ -57,7 +57,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 diff --git a/.github/ISSUE_TEMPLATE/04-remove-existing-site.yml b/.github/ISSUE_TEMPLATE/04-remove-entry.yml similarity index 81% rename from .github/ISSUE_TEMPLATE/04-remove-existing-site.yml rename to .github/ISSUE_TEMPLATE/04-remove-entry.yml index 350a724..22ee346 100644 --- a/.github/ISSUE_TEMPLATE/04-remove-existing-site.yml +++ b/.github/ISSUE_TEMPLATE/04-remove-entry.yml @@ -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:" @@ -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: @@ -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 diff --git a/.github/ISSUE_TEMPLATE/05-request-a-feature.md b/.github/ISSUE_TEMPLATE/05-request-a-feature.md index 2ca187f..1d4d04d 100644 --- a/.github/ISSUE_TEMPLATE/05-request-a-feature.md +++ b/.github/ISSUE_TEMPLATE/05-request-a-feature.md @@ -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: ### diff --git a/.github/ISSUE_TEMPLATE/06-report-a-bug.md b/.github/ISSUE_TEMPLATE/06-report-a-bug.md index 69f05ff..6ceae5a 100644 --- a/.github/ISSUE_TEMPLATE/06-report-a-bug.md +++ b/.github/ISSUE_TEMPLATE/06-report-a-bug.md @@ -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:** - + **Bug reproduction:** diff --git a/.github/ISSUE_TEMPLATE/07-open-an-issue-for-something-else.md b/.github/ISSUE_TEMPLATE/07-open-an-issue-for-something-else.md index 5d20e07..40f02df 100644 --- a/.github/ISSUE_TEMPLATE/07-open-an-issue-for-something-else.md +++ b/.github/ISSUE_TEMPLATE/07-open-an-issue-for-something-else.md @@ -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: '' diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 07f83df..d310190 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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.