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.

Sign up for GitHub

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: fixed path to crates, updated link to translating doc #2538

Merged
merged 2 commits into from
Apr 20, 2024
Merged

docs: fixed path to crates, updated link to translating doc #2538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a066310
docs: fixed path to crates, updated link to translating doc
viraxslot Apr 20, 2024
c58b6ff
docs: removed outdated information about gen-web command
viraxslot Apr 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ cargo t
You can run **a single test** with cargo by passing the test name after the `test` command:

```shell
cd crate/biome_js_formatter
cd crates/biome_js_formatter

cargo t quick_test
```
Expand Down Expand Up @@ -203,8 +203,7 @@ things you would need to run and check:
- `just l` (alias for `just lint`), run the linter for the whole project.
- Code generation. The code generation of the repository is spread in the different parts of the code base. Sometimes is needed and sometime it isn't:
- run `just gen-lint` when you're working on the **linter**;
- run `just gen-bindings` in case you worked around the **workspace**;
- run `just gen-web` when you update the `CHANGELOG.md`.
- run `just gen-bindings` in case you worked around the **workspace**.

> [!NOTE]
> You can run `just ready` as well, although it's a command that runs the codegen of the whole repository, which will take some time
Expand Down Expand Up @@ -261,7 +260,7 @@ The tests are run against the compiled files, which means that you need to run t

### Translations

For more information on how to help with translation, please see the [translation contribution guidelines for our docs](./website/TRANSLATIONS.md).
For more information on how to help with translation, please see the [translation contribution guidelines for our docs](https://github.com/biomejs/website/blob/main/TRANSLATIONS.md).

## Commit messages

Expand Down Expand Up @@ -344,12 +343,6 @@ Make sure that the created subsections are ordered in the following order:
#### Bug fixes
```

Because the website displays the changelog, you should update the website using the following command:

```sh
just gen-web
```

#### Writing a changelog line

- Use the present tense, e.g. "Add new feature", "Fix edge case".
Expand Down
4 changes: 0 additions & 4 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ gen-lint:
just gen-bindings
just format

# Generates code generated files for the website
gen-web:
cargo codegen-website

# Generates the initial files for all formatter crates
gen-formatter:
cargo run -p xtask_codegen -- formatter
Expand Down