Skip to content

Commit

Permalink
docs: use the new /chat link (#4171)
Browse files Browse the repository at this point in the history
  • Loading branch information
ematipico authored Oct 3, 2024
1 parent 0396fa3 commit 5b6e55b
Show file tree
Hide file tree
Showing 24 changed files with 69 additions and 25 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ contact_links:
url: https://github.com/biomejs/biome/discussions/new
about: Please use a new Github discussion to propose ideas of feature requests
- name: 🗣️ Chat
url: https://discord.gg/BypW39g6Yc
url: https://biomejs.dev/chat
about: Our Discord server is active and is used for real-time discussions including contribution collaboration, questions, and more!
- name: 🤔 Support
url: https://discord.gg/BypW39g6Yc
url: https://biomejs.dev/chat
about: "This issue tracker is not for support questions. Visit our community Discord and the #support channel for assistance!"
- name: 🆘 Code of Conduct Reports
url: https://github.com/biomejs/biome/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct
Expand Down
46 changes: 45 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ We can use help in a bunch of areas and any help is greatly appreciated!
- [Install the required tools](#install-the-required-tools)
- [Testing](#testing)
- [Debugging](#debugging)
- [Debug binaries](#debug-binaries)
- [Production binaries](#production-binaries)
- [Checks](#checks)
- [Crates development](#crates-development)
- [Create new crates](#create-new-crates)
Expand Down Expand Up @@ -40,7 +42,7 @@ We can use help in a bunch of areas and any help is greatly appreciated!
If you have any questions, proposals, or feedbacks, open a [GitHub discussion](https://github.com/biomejs/biome/discussions).
Make sure your comment adds value: [don't post a comment just to get attention](https://jacobtomlinson.dev/posts/2022/dont-be-that-open-source-user-dont-be-me/).

Our [Discord server](https://discord.gg/BypW39g6Yc) is open for help and more ad-hoc discussion.
Our [Discord server](https://biomejs.dev/chat) is open for help and more ad-hoc discussion.
All activity on the Discord is still moderated and will be strictly enforced under the project's [Code of Conduct](./CODE_OF_CONDUCT.md).

Remember that we are doing this project on our own time.
Expand Down Expand Up @@ -198,6 +200,48 @@ fn test_some_function() {
cargo t test_some_function --show-output
```

## Debug binaries

Creating a development binary is very useful in case you need to triage a reproduction, and you require more information like logging, trace logs, etc.

Additionally, you can use this binary when you need to debug issues related to LSP clients.

From the root of the repository, run the following command:

```shell
cargo build --bin biome
```
`cargo` will create a binary called `biome` in the `target/debug/` directory.

If you're debugging a CLI reproduction, copy the `biome` binary inside the root of the reproduction, and change any script that uses the npm package to use the binary instead:

```diff
{
"scripts": {
- "lint": "biome lint",
+ "lint": "./biome lint"
}
}
```

If you're debugging an LSP reproduction, make sure that the client allows to use custom binary, like VSCode and Zed. Provide an absolute URL to the binary that was emitted.

```json
{
"biome.lspBin": "/Users/john/www/biome/target/debug/biome"
}
```

## Production binaries

_Usually_, the easiest way to create a production build is to use the `--release` flag, **however** Biome requires an environment variable called `BIOME_VERSION` to generate different code at compile time.

When you provide a `BIOME_VERSION` that is _different_ from `0.0.0`, the build will turn off all the nursery rules that are recommended. The value of `BIOME_VERSION` doesn't matter, as long as it's different from `0.0.0`. This means that you'll have to provide a command similar to this:

```shell
BIOME_VERSION=0.0.1 cargo build --bin biome --release
```

## Checks

When you finished your work, and you are ready to **commit and open a PR**, there are few other
Expand Down
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,4 +294,4 @@ The reviewers will determine responses based on the information gathered and the
- Revoked contributor or moderator status

[gh-org]: https://github.com/biomejs
[discord]: https://discord.gg/BypW39g6Yc
[discord]: https://biomejs.dev/chat
2 changes: 1 addition & 1 deletion crates/biome_cli/src/commands/init.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Welcome to Biome! Let's get you started...
"<Dim>"5."</Dim>" "<Emphasis>"Get involved with the community"</Emphasis>"
Ask questions and contribute on GitHub: "<Hyperlink href="https://github.com/biomejs/biome">"https://github.com/biomejs/biome"</Hyperlink>"
Seek for help on Discord: "<Hyperlink href="https://discord.gg/BypW39g6Yc">"https://discord.gg/BypW39g6Yc"</Hyperlink>"
Seek for help on Discord: "<Hyperlink href="https://biomejs.dev/chat">"https://biomejs.dev/chat"</Hyperlink>"
"
});
Ok(())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ Next Steps
5. Get involved with the community
Ask questions and contribute on GitHub: https://github.com/biomejs/biome
Seek for help on Discord: https://discord.gg/BypW39g6Yc
Seek for help on Discord: https://biomejs.dev/chat
```
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ Next Steps
5. Get involved with the community
Ask questions and contribute on GitHub: https://github.com/biomejs/biome
Seek for help on Discord: https://discord.gg/BypW39g6Yc
Seek for help on Discord: https://biomejs.dev/chat
```
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ Next Steps
5. Get involved with the community
Ask questions and contribute on GitHub: https://github.com/biomejs/biome
Seek for help on Discord: https://discord.gg/BypW39g6Yc
Seek for help on Discord: https://biomejs.dev/chat
```
2 changes: 1 addition & 1 deletion crates/biome_css_formatter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_css_formatter?&color=green
[cargo-url]: https://crates.io/crates/biome_css_formatter/

Expand Down
2 changes: 1 addition & 1 deletion crates/biome_css_parser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_css_parser?&color=green
[cargo-url]: https://crates.io/crates/biome_css_parser/

Expand Down
2 changes: 1 addition & 1 deletion crates/biome_formatter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[cargo-badge]: https://badgen.net/crates/v/biome_formatter?&color=green
Expand Down
2 changes: 1 addition & 1 deletion crates/biome_graphql_formatter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_graphql_formatter?&color=green
[cargo-url]: https://crates.io/crates/biome_graphql_formatter/

Expand Down
2 changes: 1 addition & 1 deletion crates/biome_js_formatter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_js_formatter?&color=green
[cargo-url]: https://crates.io/crates/biome_js_formatter/

Expand Down
2 changes: 1 addition & 1 deletion crates/biome_js_parser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_js_parser?&color=green
[cargo-url]: https://crates.io/crates/biome_js_parser/

Expand Down
2 changes: 1 addition & 1 deletion crates/biome_json_formatter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_json_formatter?&color=green
[cargo-url]: https://crates.io/crates/biome_json_formatter/

Expand Down
2 changes: 1 addition & 1 deletion crates/biome_json_parser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_json_parser?&color=green
[cargo-url]: https://crates.io/crates/biome_json_parser/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![cargo version][cargo-badge]][cargo-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[cargo-badge]: https://badgen.net/crates/v/biome_yaml_parser?&color=green
[cargo-url]: https://crates.io/crates/biome_yaml_parser/

Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.hi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![Open VSX version][open-vsx-badge]][open-vsx-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![Open VSX version][open-vsx-badge]][open-vsx-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.kr.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![Open VSX version][open-vsx-badge]][open-vsx-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=60a5fa
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=60a5fa&label=%40biomejs%2Fbiome
[npm-url]: https://www.npmjs.com/package/@biomejs/biome/v/latest
[vscode-badge]: https://badgen.net/vs-marketplace/v/biomejs.biome?label=vscode&icon=visualstudio&color=60a5fa
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.pt-BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![versão Open VSX][open-vsx-badge]][open-vsx-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![Open VSX version][open-vsx-badge]][open-vsx-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/biome/README.zh-TW.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![Open VSX version][open-vsx-badge]][open-vsx-url]

[discord-badge]: https://badgen.net/discord/online-members/BypW39g6Yc?icon=discord&label=discord&color=green
[discord-url]: https://discord.gg/BypW39g6Yc
[discord-url]: https://biomejs.dev/chat
[ci-badge]: https://github.com/biomejs/biome/actions/workflows/main.yml/badge.svg
[ci-url]: https://github.com/biomejs/biome/actions/workflows/main.yml
[npm-badge]: https://badgen.net/npm/v/@biomejs/biome?icon=npm&color=green&label=%40biomejs%2Fbiome
Expand Down
2 changes: 1 addition & 1 deletion packages/@biomejs/js-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ The project philosophy can be found on our [website](https://biomejs.dev/interna

Contribution and development instructions can be found in [CONTRIBUTING](../../CONTRIBUTING.md).

Additional project coordination and real-time discussion happens on our [Discord server](https://discord.gg/BypW39g6Yc). Remember that all activity on the Discord server is still moderated and will be strictly enforced under the project's [Code of Conduct](../../CODE_OF_CONDUCT.md).
Additional project coordination and real-time discussion happens on our [Discord server](https://biomejs.dev/chat). Remember that all activity on the Discord server is still moderated and will be strictly enforced under the project's [Code of Conduct](../../CODE_OF_CONDUCT.md).

0 comments on commit 5b6e55b

Please sign in to comment.