Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md #4733

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update CONTRIBUTING.md #4733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ Those commands can be run on the workspace or in a specific package(`cd ./packag
| `pnpm test:watch` | Run test in watch mode(only when inside a package) |
| `pnpm watch` | Build in watch mode, Starting this command will rebuild the typescript files on save. |
| `pnpm clean` | Clean, sometimes there are ghost files left in the dist folder (common when renaming or deleting a TypeScript file), running this will get a clean state. |
| `pnpm format` | Format |
| `pnpm format:check` | Validate files are formatted |
| `pnpm gen-extern-signature` | Regenerate TypeScript signature for decorators(except compiler) |
| `pnpm change add` | Add a change description |
| `pnpm lint` | Run linters |
| `pnpm lint:fix` | Fix autofixable issues |
| `pnpm regen-samples` | Regen the samples(when the samples test fail) |
| `pnpm regen-docs` | Regen the reference docs |
| `pnpm run setup:min` `pnpm run format` | Run the formatter to reformat all files |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The setup command needs to be run before pnpm run format can be run :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is specific to the isolated packages though. All those workspace command assume you have built the workspace.

mayhe we can categorize which one only need the min setup and which one the full build


### Verbose test logging

Expand Down
Loading