Skip to content

docs: update readme and contributing for biome#1647

Closed
Morosan wants to merge 2 commits into
Endava:chore/migrate-to-stencil-vitestfrom
Morosan:docs/update-contribution-and-readme-docs-for-biome
Closed

docs: update readme and contributing for biome#1647
Morosan wants to merge 2 commits into
Endava:chore/migrate-to-stencil-vitestfrom
Morosan:docs/update-contribution-and-readme-docs-for-biome

Conversation

@Morosan

@Morosan Morosan commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the project documentation to reflect the current linting and formatting workflow based on Biome.

Documentation

Updated README.md and CONTRIBUTING.md with:

  • Biome as the linting and code formatting tool
  • The nx affected -t check command for affected publishable projects
  • The nx run beeq:check command for checking the core package
  • The --write option for autofixing supported issues

Checklist

  • I have read the CONTRIBUTING document.
  • I have read the CODE OF CONDUCT document.
  • I have reviewed my code.
  • I have tested the changes locally.
  • I have updated the documentation (if applicable).
  • I have added unit tests and e2e tests (if applicable).
  • I have requested reviews from relevant team members.

@Morosan
Morosan requested a review from dgonzalezr as a code owner April 21, 2026 11:14
Comment thread CONTRIBUTING.md Outdated
### <a name="code-formatting"></a> Code formatting

**Follow the style you see used in the repository!** Consistency with the rest of the project always trumps other considerations. It doesn't matter what you choose for your daily code implementation or if you have your style but, please, **make sure to have configured [Prettier](https://prettier.io/)** on your IDE/Code Editor.
**Follow the style you see used in the repository!** Consistency with the rest of the project always trumps other considerations. BEEQ uses [Biome](https://biomejs.dev/) for linting and code formatting, so please make sure it is configured in your IDE/editor.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
**Follow the style you see used in the repository!** Consistency with the rest of the project always trumps other considerations. BEEQ uses [Biome](https://biomejs.dev/) for linting and code formatting, so please make sure it is configured in your IDE/editor.
**Try to follow the existing style in the repository as closely as possible.** Keeping things consistent with the rest of the project is more important than following generic preferences.
BEEQ uses [Biome](https://biomejs.dev/) for linting and formatting, so it’s worth setting that up in your IDE or code editor before you start.

@sonarqubecloud

Copy link
Copy Markdown

@dgonzalezr

Copy link
Copy Markdown
Collaborator

You can change the target branch to 'main'. I think it's useful to have that info available asap.

@Morosan

Morosan commented Apr 21, 2026

Copy link
Copy Markdown
Contributor Author

You can change the target branch to 'main'. I think it's useful to have that info available asap.

Created a new PR here #1648 with a clean branch from main since this was created from chore/migrate-to-stencil-vitest

@Morosan Morosan closed this Apr 21, 2026
@Morosan
Morosan deleted the docs/update-contribution-and-readme-docs-for-biome branch April 21, 2026 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants