Psg 4897 use repo templates

passageidentity / passage-node

Passkey Complete for Node.js - Integrate into your Node.js API or service to enable a completely passwordless standalone auth solution with Passage by 1Password

http://docs.passage.id/complete

MIT License

23 stars 7 forks source link

Psg 4897 use repo templates #163

Closed jenn-macfarlane closed 4 weeks ago

jenn-macfarlane commented 1 month ago

What's New?

Updates README, LICENCE, and package.json files.

Screenshots (if appropriate):

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[X] Documentation update

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have manually tested my code thoroughly
[x] I have added/updated inline documentation for public facing interfaces if relevant
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing integration and unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules

Additional context

jenn-macfarlane commented 1 month ago

Let me know if I misunderstood what to do here - our README template example happened to be for passage-node so I copied that.

Also looks like the PR template used is not coming from this repo/I checked to ensure we don't have any of the PR/Issue/Code of Conduct/Security files we will be inheriting from the Passage org's default community health files. Please let me know if I'm right there too!

jenn-macfarlane commented 4 weeks ago

@agebhardt fixed!

Glad you agree with making the technical instructions in this README minimal (taken straight from your example!). My understanding is we want to get as close to this minimal install/import/initialize format in the technical section to minimize drift/duplication of docs. Is my understanding correct?

flanagankp commented 4 weeks ago

I think as part of this work we also want to make corresponding updates to the package.json - namely the description, homepage, and keywords to align with the description, url, and github tags

jenn-macfarlane commented 4 weeks ago

@flanagankp good catch, done. Quick question - there's no risk updating the homepage, right? I vaguely recall setting this field in create-react-app would change where the project is served from, that's a super specific and unrelated case but has me wondering if we need to be careful about this with any other build systems/stacks.

sonarcloud[bot] commented 4 weeks ago

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud