Skip to content

Commit 573052c

Browse files
N2D4N2D4
committed
Update CONTRIBUTING.md
1 parent dfb51b8 commit 573052c

File tree

2 files changed

+27
-8
lines changed

2 files changed

+27
-8
lines changed

‎.vscode/extensions.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
3+
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
4+
5+
// List of extensions which should be recommended for users of this workspace.
6+
"recommendations": [
7+
"dbaeumer.vscode-eslint"
8+
],
9+
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
10+
"unwantedRecommendations": [
11+
12+
]
13+
}

‎CONTRIBUTING.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22

33
Welcome to Stack Auth!
44

5-
Due to the nature of authentication, this may not be the easiest project to contribute to, so if you are looking for projects to help gain programming experience, we may not be a great match. However, the easiest way to help is by contributing to our documentation and creating examples & guides. This way, you can share your knowledge and expertise with everyone else, and it's a great way to understand Stack Auth from the inside before contributing code changes. It is also a great way for us to assess your skills and understand where you could best help the project.
6-
7-
If you're interested, please join [our Discord](https://discord.stack-auth.com) and get in touch.
5+
Due to the nature of authentication, this may not be the easiest project to contribute to, so if you are looking for projects to help gain programming experience, we may not be a great match. If you're looking for projects for beginners, check out [Awesome First PR Opportunities](https://github.com/MunGell/awesome-for-beginners).
86

97
# Note: We are not currently hiring.
108

11-
## First time contributors
9+
## How to contribute
10+
11+
If you think Stack Auth is a good fit for you, follow these steps:
1212

13-
If you would like to contribute to the project, you can start by looking at the issues labeled as [good first issue](https://github.com/stack-auth/stack/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22),
13+
1. Join [our Discord](https://discord.stack-auth.com)
14+
2. [Use Stack Auth](https://docs.stack-auth.com/getting-started/setup). The best way to understand the project is to use it. Build an application on top of Stack Auth, and post it on GitHub or write a blog post about how you built it. This also lets us assess your skills and understand where you could best help the project.
15+
3. Give us feedback on Discord or GitHub; let us know where you got stuck, and which things you wish were easier. (We appreciate contributions most when they solve problems the authors encountered themselves in real usage.)
16+
4. Contribute to the [documentation](https://docs.stack-auth.com) and create examples & guides. This way, you can share your knowledge and expertise with everyone else who's just getting started.
17+
5. Only then, start contributing to the codebase. Coordinate with us on Discord beforehand to ensure we are not working on the same thing already, and to make sure a task is not more difficult than it seems.
1418

1519

1620
## Security & bug bounties
@@ -23,7 +27,9 @@ For any security-related concerns & bug bounties, please email us at [security@s
2327
Please make sure to:
2428

2529
- Install ESLint in your IDE and follow the code format of the code base (e.g., spaces around `=`, semicolons at the end, etc.).
26-
- Run `pnpm typecheck`, `pnpm lint`, and `pnpm build`. `pnpm prisma migrate dev` All of them should pass.
27-
- Create only one DB migration file per PR.
30+
- If you are using VSCode, select "Show Recommended Extensions" from the command palette (`Ctrl+Shift+P`) to install the recommended extensions.
31+
- Run `pnpm run test`. All tests should pass.
32+
- If you changed the Prisma schema, make sure you've created a migration file. Create only one DB migration file per PR.
33+
- If you changed the API, make sure you have added endpoint tests in `apps/e2e`.
2834
- Ensure all dependencies are in the correct `package.json` files.
29-
- Ensure the PR is ready for review. If you want to discuss WIP code, make it a draft.
35+
- Ensure the PR is ready for review. If you want to discuss WIP code, mark it as a draft.

0 commit comments

Comments
 (0)