Browse Source

Cleanup README.md and contributor documentation (#3909)

pull/3913/head
José Julián Espina 4 months ago committed by GitHub
parent
commit
f80c53229a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 4
      .github/ISSUE_TEMPLATE/config.yml
  2. 3
      CODE_OF_CONDUCT.md
  3. 4
      CONTRIBUTING.md
  4. 10
      README.md
  5. 6
      SECURITY.md

4
.github/ISSUE_TEMPLATE/config.yml

@ -1,5 +1,5 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Discord channel - name: Matrix space
url: https://discord.gg/tUFFk9Y url: https://matrix.to/#/#boa:matrix.org
about: Please ask and answer questions here. about: Please ask and answer questions here.

3
CODE_OF_CONDUCT.md

@ -60,8 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement at
[discord](https://discord.gg/tUFFk9Y) by contacting anyone in the _@boa_dev_ [Matrix](https://matrix.to/#/#boa:matrix.org) by contacting any of the admins in the space.
group (check the yellow usernames).
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the

4
CONTRIBUTING.md

@ -111,8 +111,8 @@ cargo doc --all-features --document-private-items --workspace --no-deps
## Communication ## Communication
We have a Discord server, feel free to ask questions here: We have a Matrix space, feel free to ask questions here:
<https://discord.gg/tUFFk9Y> <https://matrix.to/#/#boa:matrix.org>
[issues]: https://github.com/boa-dev/boa/issues [issues]: https://github.com/boa-dev/boa/issues
[rustup]: https://rustup.rs/ [rustup]: https://rustup.rs/

10
README.md

@ -43,8 +43,9 @@ Boa currently publishes and actively maintains the following crates:
- **`boa_profiler`** - Boa's code profiler - **`boa_profiler`** - Boa's code profiler
- **`boa_icu_provider`** - Boa's ICU4X data provider - **`boa_icu_provider`** - Boa's ICU4X data provider
- **`boa_runtime`** - Boa's WebAPI features - **`boa_runtime`** - Boa's WebAPI features
- **`boa_string`** - Boa's ECMAScript string implementation.
Please note: the `Boa` and `boa_unicode` crate are deprecated. Please note: the `Boa` and `boa_unicode` crates are deprecated.
## Boa Engine Example ## Boa Engine Example
@ -54,7 +55,7 @@ Add the below dependency to your `Cargo.toml`:
```toml ```toml
[dependencies] [dependencies]
boa_engine = "0.17.3" boa_engine = "0.19.0"
``` ```
Then in `main.rs`, copy the below: Then in `main.rs`, copy the below:
@ -178,8 +179,9 @@ See [CHANGELOG.md](./CHANGELOG.md).
## Communication ## Communication
Feel free to contact us on [Discord](https://discord.gg/tUFFk9Y) for any questions or issues. The general Feel free to contact us on [Matrix](https://matrix.to/#/#boa:matrix.org) if you have any questions.
contributor chat for Boa occurs on [Matrix](https://matrix.to/#/#boa:matrix.org) if you're interested in contributing. Contributor discussions take place on the same Matrix Space if you're interested in contributing.
We also have a [Discord](https://discord.gg/tUFFk9Y) for any questions or issues.
## License ## License

6
SECURITY.md

@ -11,6 +11,6 @@ on [crates.io][crate].
## Reporting a Vulnerability ## Reporting a Vulnerability
If you find any potential vulnerability, join our [discord](https://discord.gg/tUFFk9Y) channel If you find any potential vulnerability, join our [Matrix](https://matrix.to/#/#boa:matrix.org) space
and contact anyone in the _@boa_dev_ group (check the yellow usernames). Explain how to trigger and contact anyone who is an admin. Explain how to trigger the vulnerability, where can it be found
the vulnerability, where can it be found and any recommendation you might have to fix it. and any recommendation you might have to fix it.

Loading…
Cancel
Save