diff --git a/.github/ISSUE_TEMPLATE/alpha.yml b/.github/ISSUE_TEMPLATE/alpha.yml new file mode 100644 index 0000000..dba4db4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/alpha.yml @@ -0,0 +1,39 @@ +name: Report a problem +description: Tell us about something that went wrong in the alpha. +body: + - type: markdown + attributes: + value: >- + This is alpha software. Thank you for reporting. We read every issue, + but may not answer or fix it during the alpha. + - type: textarea + id: what-you-did + attributes: + label: What you did + description: The steps you took, in order. + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened + description: What you saw. Include any error message. + validations: + required: true + - type: textarea + id: what-you-expected + attributes: + label: What you expected + validations: + required: true + - type: upload + id: screenshots + attributes: + label: Screenshots + description: >- + Optional. Drag images here or click to choose them. Screenshots are + public, like the rest of this issue, so cover your email, your name, + and anything else private first. + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.webp" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/README.md b/README.md index f5e7898..4770e12 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # verifier-plugin +> [!IMPORTANT] +> **Alpha.** This is part of the Learner Credential Wallet alpha, an early test +> version. It may change without notice. We read issues, but may not answer or +> fix them during the alpha. + A credential viewer and verifier for the Digital Credentials Commons web wallet, built as a plugin rather than as part of the wallet itself. @@ -45,7 +50,7 @@ people look at. It has run inside the LCW web wallet, in dev and production builds, with plain and encrypted collections (lcw-front-end#104). That pull request was closed in -favour of the wallet's plugin interface, which this package now follows: see +favor of the wallet's plugin interface, which this package now follows: see **Using it in the LCW web wallet**. No screen reader has heard it yet. See **Open questions**. @@ -225,7 +230,7 @@ The requirements and the list of everything verification can report live in report, in two tiers. They live here rather than in a planning repo so they move with the code. A -change in behaviour that leaves them untouched should look wrong in review โ€” +change in behavior that leaves them untouched should look wrong in review โ€” which is how ยง4 came to describe something its own implementation no longer did. @@ -301,7 +306,7 @@ credential names its withdrawal list by full address. They use the same test issuer as `dev/fixtures`, whose key comes from a fixed seed in `scripts/make-fixtures.js` โ€” so it is public, and anyone can sign as it. The published `fixtures/registry.json` says so in its own note. It is there to show -what a recognised issuer looks like, and must never be configured as a real +what a recognized issuer looks like, and must never be configured as a real registry. ### Changing `src/outcomes.ts` @@ -325,7 +330,7 @@ Two rules fall out of it, both learned the hard way: one place from the checks that came back. Writing it as fixed text is how it went wrong three times. - **Do not name a cause the log cannot establish.** A withdrawal check that - left no step behind might be an unrecognised status method, or verification + left no step behind might be an unrecognized status method, or verification stopping earlier. The row says "not checked" and guesses at neither. ### The test credentials @@ -388,6 +393,6 @@ Open on the wording, and none of them are bugs: themselves. It is the point of that outcome and the least settled part of it. -## Licence +## License MIT