-
-
Notifications
You must be signed in to change notification settings - Fork 504
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.
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
chore: update CONTRIBUTING.md #472
Conversation
@@ -229,41 +283,6 @@ pnpm install | |||
pnpm start | |||
``` | |||
|
|||
### Generated files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
move to crate development section
### Versioning | ||
|
||
We follow the specs suggested by [the official documentation](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions): | ||
|
||
Odd minor versions are dedicated to pre-releases, e.g. `*.5.*` . | ||
Even minor versions are dedicated to official releases, e.g. `*.6.*`. | ||
|
||
### Playground |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is outdated.
### Analyzers and lint rules | ||
|
||
To know the technical details of how our analyzer works, how to create a rule and how to write tests, please check our [contribution page](https://github.com/biomejs/biome/blob/main/crates/biome_analyze/CONTRIBUTING.md) | ||
|
||
### Formatter | ||
|
||
To know the technical details of how our formatter works and how to write test, please check our [contribution page](https://github.com/biomejs/biome/blob/main/crates/biome_js_formatter/CONTRIBUTING.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
move to crates development section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I added some feedback :)
CONTRIBUTING.md
Outdated
This command will create new tests for your parser. We currently have a neat infrastructure | ||
where tests for parser are generated com inline comments found inside | ||
the source code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are moving away from this approach. While the JS and JSON parsers still use this infra, the CSS parser now uses a more straightforward process. Maybe we should rephrase this paragraph to communicate this to the contributors.
Co-authored-by: Emanuele Stoppa <[email protected]>
Co-authored-by: Emanuele Stoppa <[email protected]>
Co-authored-by: Emanuele Stoppa <[email protected]>
Thank you for reviews! I updated based on your comments. |
Summary
Update CONTRIBUTING.md
Test Plan