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

docs: improve analyze guide #2910

Merged
merged 4 commits into from
May 18, 2024
Merged

docs: improve analyze guide #2910

merged 4 commits into from
May 18, 2024

Conversation

ematipico
Copy link
Member

@ematipico ematipico commented May 18, 2024

Summary

Adds more information in the contribution guidelines.

I added:

  • what's a nursery group
  • some tips on how developers should write rules
  • explanation of declare_node_union
  • code tips around the try operator and let else

I moved the sections around, in order to create a flow that made sense:

  • concepts
  • coding
    • macros
    • semantic model
    • etc.
  • testing
  • documentation
  • codegen
  • commit

Before, it didn't make sense.

Test Plan

Proofread.

Here's the rendered file, the code diff doesn't help.

@github-actions github-actions bot added the A-Linter Area: linter label May 18, 2024
@ematipico ematipico requested review from a team May 18, 2024 09:50
Copy link
Member

@Conaclos Conaclos left a comment

Choose a reason for hiding this comment

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

Much better! I left some fixes and suggestions.

crates/biome_analyze/CONTRIBUTING.md Outdated Show resolved Hide resolved
crates/biome_analyze/CONTRIBUTING.md Show resolved Hide resolved
crates/biome_analyze/CONTRIBUTING.md Show resolved Hide resolved
crates/biome_analyze/CONTRIBUTING.md Outdated Show resolved Hide resolved
recommended: false,
}
}
```

### Custom Visitors
Copy link
Member

Choose a reason for hiding this comment

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

Should we add some words about fix_kind and sources?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll do it in a second Pr

crates/biome_analyze/CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@Sec-ant Sec-ant left a comment

Choose a reason for hiding this comment

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

And a line that is not edited:

_Biome_ follows a naming convention according to what the rule do:

according to what the rule do: => according to what the rule does:

crates/biome_analyze/CONTRIBUTING.md Outdated Show resolved Hide resolved
ematipico and others added 2 commits May 18, 2024 17:19
@ematipico ematipico merged commit 9a05b77 into main May 18, 2024
4 checks passed
@ematipico ematipico deleted the docs/more-info branch May 18, 2024 16:20
Copy link

codspeed-hq bot commented May 18, 2024

CodSpeed Performance Report

Merging #2910 will not alter performance

Comparing docs/more-info (5dbd55f) with main (2226bae)

Summary

✅ 87 untouched benchmarks

🆕 5 new benchmarks
⁉️ 12 (👁 12) dropped benchmarks

Benchmarks breakdown

Benchmark main docs/more-info Change
🆕 json_formatter[big5-added.json] N/A 8.9 ms N/A
🆕 json_formatter[canada.json] N/A 3.8 s N/A
👁 json_formatter[compiler.js] 2.9 s N/A N/A
👁 json_formatter[d3.min.js] 2.3 s N/A N/A
🆕 json_formatter[db.json] N/A 257.8 ms N/A
👁 json_formatter[dojo.js] 158.9 ms N/A N/A
🆕 json_formatter[eucjp.json] N/A 16.8 ms N/A
👁 json_formatter[jquery.min.js] 665 ms N/A N/A
👁 json_formatter[math.js] 4.7 s N/A N/A
🆕 json_formatter[package-lock.json] N/A 114.2 ms N/A
👁 json_formatter[pixi.min.js] 2.6 s N/A N/A
👁 json_formatter[react-dom.production.min.js] 789.7 ms N/A N/A
👁 json_formatter[react.production.min.js] 40.4 ms N/A N/A
👁 json_formatter[tex-chtml-full.js] 5.8 s N/A N/A
👁 json_formatter[three.min.js] 3.1 s N/A N/A
👁 json_formatter[typescript.js] 18.5 s N/A N/A
👁 json_formatter[vue.global.prod.js] 1 s N/A N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Linter Area: linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants