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.

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

Merged
merged 5 commits into from
Oct 3, 2023
Merged

chore: update CONTRIBUTING.md #472

merged 5 commits into from
Oct 3, 2023

Conversation

nissy-dev
Copy link
Contributor

@nissy-dev nissy-dev commented Oct 2, 2023

Summary

Update CONTRIBUTING.md

Test Plan

@nissy-dev nissy-dev temporarily deployed to Website deployment October 2, 2023 15:07 — with GitHub Actions Inactive
@@ -229,41 +283,6 @@ pnpm install
pnpm start
```

### Generated 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.

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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is outdated.

Comment on lines -376 to -382
### 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)
Copy link
Contributor Author

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

Copy link
Member

@ematipico ematipico left a 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 Show resolved Hide resolved
CONTRIBUTING.md Outdated
Comment on lines 136 to 138
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.
Copy link
Member

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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Emanuele Stoppa <[email protected]>
@nissy-dev nissy-dev temporarily deployed to Website deployment October 3, 2023 12:25 — with GitHub Actions Inactive
Co-authored-by: Emanuele Stoppa <[email protected]>
@nissy-dev nissy-dev temporarily deployed to Website deployment October 3, 2023 12:28 — with GitHub Actions Inactive
Co-authored-by: Emanuele Stoppa <[email protected]>
@nissy-dev nissy-dev temporarily deployed to Website deployment October 3, 2023 12:31 — with GitHub Actions Inactive
@nissy-dev nissy-dev temporarily deployed to Website deployment October 3, 2023 13:12 — with GitHub Actions Inactive
@nissy-dev
Copy link
Contributor Author

Thank you for reviews! I updated based on your comments.

@nissy-dev nissy-dev merged commit 053a8d2 into main Oct 3, 2023
5 checks passed
@nissy-dev nissy-dev deleted the update-contributing-md branch October 3, 2023 14:56
@Conaclos Conaclos added the A-Changelog Area: changelog label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Changelog Area: changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants