Skip to content

Commit 12f7be4

Browse files
ndom91ndom91
authored
chore: update README.md header, security and sponsors sections (#1)
* feat: update README.md header, security and sponsors sections * fix: add contributing section * feat: add .github/* repo organisation files * fix: add package.json organisation fields
1 parent 68da581 commit 12f7be4

File tree

6 files changed

+262
-5
lines changed

6 files changed

+262
-5
lines changed

‎.github/ISSUE_TEMPLATE/1_bug.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug report
2+
description: Report an issue so we can improve
3+
labels: [triage, bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**NOTE:** Issues that are potentially security related should be reported to us by following the [Security guidelines](https://next-auth.js.org/security) rather than on GitHub.
9+
Thanks for taking the time to fill out this issue after reading/searching through the [documentation](https://next-auth.js.org) first!
10+
Is this your first time contributing? Check out this video: https://www.youtube.com/watch?v=cuoNzXFLitc
11+
12+
### Important :exclamation:
13+
14+
_Providing incorrect/insufficient information or skipping steps to reproduce the issue may result in closing the issue or converting to a discussion without further explanation._
15+
16+
If you have a generic question specific to your project, it is best asked in Discussions under the [Questions category](https://github.com/nextauthjs/next-auth/discussions/new?category=Questions)
17+
- type: textarea
18+
attributes:
19+
label: Environment
20+
description: |
21+
Run this command in your project's root folder and paste the result:
22+
23+
`npx envinfo --system --binaries --browsers --npmPackages "{next,react,next-auth,@auth/*}"`
24+
25+
Alternatively, you can manually gather the version information from your package.json for these packages: "next", "react" and "next-auth". Please also mention your OS and Node.js version, as well as the browser you are using.
26+
validations:
27+
required: true
28+
# Not sure how feasible it is to make reproduction URLs for a CLI :thinking:
29+
# - type: input
30+
# attributes:
31+
# label: Reproduction URL
32+
# description: A URL to a repository/code that clearly reproduces your issue. You can use our [`next-auth-example`](https://github.com/nextauthjs/next-auth-example) template repository to get started more easily, or link to your project if it's public
33+
# validations:
34+
# required: true
35+
- type: textarea
36+
attributes:
37+
label: Describe the issue
38+
description: Describe us what the issue is and what have you tried so far to fix it. Add any extra useful information in this section. Feel free to use screenshots (but prefer [code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) over a picture of your code) or a video explanation.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: How to reproduce
44+
description: Explain with clear steps how to reproduce the issue
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Expected behavior
50+
description: Explain what should have happened instead of what actually happened
51+
validations:
52+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/nextauthjs/next-auth/discussions/new?category=questions
5+
about: Ask questions and discuss with other community members
6+
- name: Feature request
7+
url: https://github.com/nextauthjs/next-auth/discussions/new?category=ideas
8+
about: Feature requests should be opened as discussions

‎.github/PULL_REQUEST_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--
2+
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
3+
4+
Please fill out the information below to expedite the review and (hopefully)
5+
merge of your pull request!
6+
7+
**NOTE**:
8+
9+
- It's a good idea to open an issue first to discuss potential changes.
10+
- Please make sure that you are _NOT_ opening a PR to fix a potential security vulnerability. Instead, please follow the [Security guidelines](https://github.com/nextauthjs/.github/blob/main/SECURITY.md) to disclose the issue to us confidentially.
11+
12+
-->
13+
14+
## ☕️ Reasoning
15+
16+
<!-- What changes are being made? What feature/bug is being fixed here? -->
17+
18+
## 🧢 Checklist
19+
20+
- [ ] Documentation
21+
- [ ] Tests
22+
- [ ] Ready to be merged
23+
24+
## 🎫 Affected issues
25+
26+
<!--
27+
Please [scout and link issues](https://github.com/nextauthjs/next-auth/issues) that might be solved by this PR. And include text like the following to close them automatically when this is merged:
28+
29+
Fixes: INSERT_ISSUE_LINK_HERE
30+
-->
31+
32+
## 📌 Resources
33+
34+
- [Security guidelines](https://github.com/nextauthjs/.github/blob/main/SECURITY.md)
35+
- [Contributing guidelines](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md)
36+
- [Code of conduct](https://github.com/nextauthjs/.github/blob/main/CODE_OF_CONDUCT.md)
37+
- [Contributing to Open Source](https://kcd.im/pull-request)

‎.github/stale.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# https://github.com/probot/stale#usage
2+
3+
daysUntilStale: 60
4+
daysUntilClose: 7
5+
exemptLabels:
6+
- pinned
7+
- security
8+
- priority
9+
- bug
10+
- triage
11+
- accepted
12+
staleLabel: stale
13+
markComment: >
14+
It looks like this issue did not receive any activity for 60 days.
15+
It will be closed in 7 days if no further activity occurs. If you think your issue
16+
is still relevant, commenting will keep it open. Thanks!
17+
closeComment: >
18+
To keep things tidy, we are closing this issue for now.
19+
If you think your issue is still relevant, leave a comment
20+
and we might reopen it. Thanks!

‎README.md

+134-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
# Auth.js CLI
1+
<p align="center">
2+
<br/>
3+
<a href="https://authjs.dev" target="_blank"><img width="96px" src="https://authjs.dev/img/logo/logo-sm.png" /></a>
4+
<h3 align="center">Auth.js CLI</h3>
5+
<p align="center">Authentication for the Web.</p>
6+
<p align="center">Open Source. Full Stack. Own Your Data.</p>
7+
<p align="center" style="align: center;">
8+
<a href="https://npm.im/auth">
9+
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
10+
</a>
11+
<a href="https://www.npmtrends.com/auth">
12+
<img src="https://img.shields.io/npm/dm/auth?style=flat-square" alt="Downloads" />
13+
</a>
14+
<a href="https://github.com/nextauthjs/auth-cli/stargazers">
15+
<img src="https://img.shields.io/github/stars/nextauthjs/auth-cli?style=flat-square" alt="Github Stars" />
16+
</a>
17+
<a href="https://www.npmjs.com/package/auth">
18+
<img src="https://img.shields.io/github/v/release/nextauthjs/auth-cli?label=latest&style=flat-square" alt="Github Stable Release" />
19+
</a>
20+
</p>
21+
<p align="center">
22+
Auth.js CLI is a multi-purpose CLI to get started and manage Auth.js projects.
23+
</p>
24+
</p>
225

326
The CLI tool by [Auth.js](https://authjs.dev) to supercharge your authentication workflow.
427

@@ -27,6 +50,116 @@ Commands:
2750
help [command] display help for command
2851
```
2952

53+
## Security
54+
55+
If you think you have found a vulnerability (or are not sure) in Auth.js or any of the related packages (i.e. Adapters), we ask you to read our [Security Policy](https://authjs.dev/security) to reach out responsibly. Please do not open Pull Requests/Issues/Discussions before consulting with us.
56+
3057
## Acknowledgements
3158

3259
Special thanks to Craig for the `auth` package name on npm.
60+
61+
### Sponsors
62+
63+
We have an [OpenCollective](https://opencollective.com/nextauth) for companies and individuals looking to contribute financially to the project!
64+
65+
<!--sponsors start-->
66+
<table>
67+
<tbody>
68+
<tr>
69+
<td align="center" valign="top">
70+
<a href="https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=authjs&utm_content=sponsor" target="_blank">
71+
<img width="108" src="https://avatars.githubusercontent.com/u/49538330?s=200&v=4" alt="Clerk Logo" />
72+
</a><br />
73+
<div>Clerk</div>
74+
<sub>💵</sub>
75+
</td>
76+
<td align="center" valign="top">
77+
<a href="https://vercel.com" target="_blank">
78+
<img width="108" src="https://avatars.githubusercontent.com/u/14985020?s=200&v=4" alt="Vercel Logo" />
79+
</a><br />
80+
<div>Vercel</div>
81+
<sub>💵☁️</sub>
82+
</td>
83+
<td align="center" valign="top">
84+
<a href="https://fusionauth.io" target="_blank">
85+
<img width="108" src="https://avatars.githubusercontent.com/u/41974756?s=200&v=4" alt="FusionAuth Logo" />
86+
</a><br />
87+
<div>FusionAuth</div>
88+
<sub>💵</sub>
89+
</td>
90+
<td align="center" valign="top">
91+
<a href="https://www.beyondidentity.com" target="_blank">
92+
<img width="108" src="https://avatars.githubusercontent.com/u/69811361?s=200&v=4" alt="Beyond Identity Logo" />
93+
</a><br />
94+
<div>Beyond Identity</div>
95+
<sub>💵</sub>
96+
</td>
97+
<td align="center" valign="top">
98+
<a href="https://stytch.com" target="_blank">
99+
<img width="108" src="https://avatars.githubusercontent.com/u/69983493?s=200&v=4" alt="Stytch Logo" />
100+
</a><br />
101+
<div>Stytch</div>
102+
<sub>💵</sub>
103+
</td>
104+
<td align="center" valign="top">
105+
<a href="https://prisma.io" target="_blank">
106+
<img width="108" src="https://avatars.githubusercontent.com/u/17219288?s=200&v=4" alt="Prisma Logo" />
107+
</a><br />
108+
<div>Prisma</div>
109+
<sub>💵</sub>
110+
</td>
111+
<td align="center" valign="top">
112+
<a href="https://lowdefy.com" target="_blank">
113+
<img width="108" src="https://avatars.githubusercontent.com/u/47087496?s=200&v=4" alt="Lowdefy Logo" />
114+
</a><br />
115+
<div>Lowdefy</div>
116+
<sub>💵</sub>
117+
</td>
118+
<td align="center" valign="top">
119+
<a href="https://workos.com" target="_blank">
120+
<img width="108" src="https://avatars.githubusercontent.com/u/47638084?s=200&v=4" alt="WorkOS Logo" />
121+
</a><br />
122+
<div>WorkOS</div>
123+
<sub>💵</sub>
124+
</td>
125+
</tr>
126+
<tr>
127+
<td align="center" valign="top">
128+
<a href="https://www.descope.com" target="_blank">
129+
<img width="108" src="https://avatars.githubusercontent.com/u/97479186?s=200&v=4" alt="Descope Logo" />
130+
</a><br />
131+
<div>Descope</div>
132+
<sub>💵</sub>
133+
</td>
134+
<td align="center" valign="top">
135+
<a href="https://checklyhq.com" target="_blank">
136+
<img width="108" src="https://avatars.githubusercontent.com/u/25982255?s=200&v=4" alt="Checkly Logo" />
137+
</a><br />
138+
<div>Checkly</div>
139+
<sub>☁️</sub>
140+
</td>
141+
<td align="center" valign="top">
142+
<a href="https://superblog.ai/" target="_blank">
143+
<img width="108" src="https://d33wubrfki0l68.cloudfront.net/cdc4a3833bd878933fcc131655878dbf226ac1c5/10cd6/images/logo_bolt_small.png" alt="superblog Logo" />
144+
</a><br />
145+
<div>superblog</div>
146+
<sub>☁️</sub>
147+
</td>
148+
</tr>
149+
</tbody>
150+
</table>
151+
152+
- 💵 Financial Sponsor
153+
- ☁️ Infrastructure Support
154+
155+
<br />
156+
<!--sponsors end-->
157+
158+
## Contributing
159+
160+
We're open to all community contributions! If you'd like to contribute in any way, please first read
161+
our [Contributing Guide](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md).
162+
163+
## License
164+
165+
MIT

‎package.json

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
{
22
"name": "auth",
3-
"description": "The CLI tool by Auth.js to supercharge your authentication workflow.",
4-
"homepage": "https://cli.authjs.dev",
53
"version": "1.0.2",
4+
"homepage": "https://cli.authjs.dev",
5+
"repository": "https://github.com/nextauthjs/auth-cli.git",
6+
"description": "The CLI tool by Auth.js to supercharge your authentication workflow.",
7+
"author": "Balázs Orbán <[email protected]>",
8+
"contributors": [
9+
"Balázs Orbán <[email protected]>",
10+
"Nico Domino <[email protected]>",
11+
"Lluis Agusti <[email protected]>",
12+
"Thang Huu Vu <[email protected]>"
13+
],
14+
"license": "MIT",
615
"type": "module",
716
"bin": {
817
"auth": "index.js"
@@ -17,8 +26,6 @@
1726
"authjs",
1827
"cli"
1928
],
20-
"author": "Balázs Orbán <[email protected]>",
21-
"license": "MIT",
2229
"dependencies": {
2330
"commander": "11.1.0"
2431
},

0 commit comments

Comments
 (0)