Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

docs: getting started #4600

Merged
merged 3 commits into from
Jun 22, 2023
Merged

docs: getting started #4600

merged 3 commits into from
Jun 22, 2023

Conversation

ematipico
Copy link
Contributor

Summary

I took the opportunity to change things around contribution guidelines and the tools we use in the repository:

  • we now format .toml files, which is very convenient. It's not set in the CI and we keep it that way for now
  • added more scripts inside justfile, which should make our development process smoother. For example, I like the command just test-crate rome_cli, which we can run from anywhere, regardless of where we are.
  • all scripts in justfile are now documented, and some of them have aliases
  • we should use nextest, which should be faster at running tests
  • I made the contribution guidelines smaller and more straight forward: setup -> install tools -> test -> commit. I believe it could work

Test Plan

N/A

Changelog

N/A

  • The PR requires a changelog line

Documentation

  • The PR requires documentation
  • I will create a new PR to update the documentation

@netlify
Copy link

netlify bot commented Jun 22, 2023

Deploy Preview for docs-rometools canceled.

Name Link
🔨 Latest commit d238e58
🔍 Latest deploy log https://app.netlify.com/sites/docs-rometools/deploys/64940d7c08ac9f00083d9e90

@github-actions github-actions bot added A-CLI Area: CLI A-Core Area: core A-Diagnostic Area: errors and diagnostics A-Formatter Area: formatter A-Linter Area: linter A-LSP Area: language server protocol A-Parser Area: parser A-Project Area: project configuration and loading A-Tooling Area: our own build, development, and release tooling labels Jun 22, 2023
@github-actions
Copy link

Parser conformance results on ubuntu-latest

js/262

Test result main count This PR count Difference
Total 48863 48863 0
Passed 47810 47810 0
Failed 1053 1053 0
Panics 0 0 0
Coverage 97.84% 97.84% 0.00%

jsx/babel

Test result main count This PR count Difference
Total 40 40 0
Passed 37 37 0
Failed 3 3 0
Panics 0 0 0
Coverage 92.50% 92.50% 0.00%

symbols/microsoft

Test result main count This PR count Difference
Total 6212 6212 0
Passed 1763 1763 0
Failed 4449 4449 0
Panics 0 0 0
Coverage 28.38% 28.38% 0.00%

ts/babel

Test result main count This PR count Difference
Total 639 639 0
Passed 573 573 0
Failed 66 66 0
Panics 0 0 0
Coverage 89.67% 89.67% 0.00%

ts/microsoft

Test result main count This PR count Difference
Total 17224 17224 0
Passed 13121 13121 0
Failed 4103 4103 0
Panics 0 0 0
Coverage 76.18% 76.18% 0.00%

@ematipico ematipico merged commit 89faa6c into main Jun 22, 2023
@ematipico ematipico deleted the docs/getting-started branch June 22, 2023 10:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-CLI Area: CLI A-Core Area: core A-Diagnostic Area: errors and diagnostics A-Formatter Area: formatter A-Linter Area: linter A-LSP Area: language server protocol A-Parser Area: parser A-Project Area: project configuration and loading A-Tooling Area: our own build, development, and release tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant