From 1d4fb8b6574d3b301f4e09c00c6d428172faa8e6 Mon Sep 17 00:00:00 2001 From: Iban Eguia Moraza Date: Sat, 25 Mar 2023 22:18:49 +0100 Subject: [PATCH 1/2] Fixed a bunch of documentation links, added a simple security policy. --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 5 +++++ README.md | 11 ++++------- SECURITY.md | 16 ++++++++++++++++ boa_ast/src/lib.rs | 6 +++--- boa_engine/src/lib.rs | 6 +++--- boa_gc/src/lib.rs | 6 +++--- boa_interner/src/lib.rs | 6 +++--- boa_parser/src/lib.rs | 6 +++--- boa_profiler/src/lib.rs | 6 +++--- boa_unicode/src/lib.rs | 6 +++--- 11 files changed, 47 insertions(+), 29 deletions(-) create mode 100644 SECURITY.md diff --git a/CHANGELOG.md b/CHANGELOG.md index c54af093f88..67bc08ef22b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1087,7 +1087,7 @@ Cargo has great support for workspaces, so this shouldn't be an issue. ## Benchmarks -We now have [benchmarks which run against master](https://boa-dev.github.io/boa/dev/bench)! +We now have [benchmarks which run against master](https://boajs.dev/boa/dev/bench/)! Thanks to Github Actions these will run automatically a commit is merged. Feature enhancements: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 407431cfbcd..03a8fe51ae8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,6 +104,11 @@ be more readable if you disable parallelism with the `-d` flag. All together it cargo run --release --bin boa_tester -- run -vv -d -s test/language/types/number 2> error.log ``` +## Documentation + +We have specific documentation for development, updated on each commit to the `main` branch, with all the private +methods visible here: + ## Communication We have a Discord server, feel free to ask questions here: diff --git a/README.md b/README.md index b5230b8d462..f731dd5d238 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,14 @@ Currently, it has support for some of the language. ## Live Demo (WASM) - + You can get more verbose errors when running from the command line. -## Development documentation - -You can check the internal development docs at . - ## Conformance -To know how much of the _ECMAScript_ specification does Boa cover, you can check out results running the _ECMASCript Test262_ test suite [here](https://boa-dev.github.io/boa/test262/). +To know how much of the _ECMAScript_ specification does Boa cover, you can check out results +running the _ECMASCript Test262_ test suite [here](https://boajs.dev/boa/test262/). ## Contributing @@ -124,7 +121,7 @@ See [Milestones](https://github.com/boa-dev/boa/milestones). ## Benchmarks -See [Benchmarks](https://boa-dev.github.io/boa/dev/bench/). +See [Benchmarks](https://boajs.dev/boa/dev/bench/). ## Profiling diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000000..de40c556cd4 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,16 @@ +# Security Policy + +## Supported Versions + +Until we reach the 1.0 version, we only support the lates released 0.x version and the current +`main` branch. You can find the latest released version of Boa in the [GitHub releases][gh_releases] +page or on [crates.io][crate]. + +[gh_releases]: https://github.com/boa-dev/boa/releases +[crate]: https://crates.io/crates/boa_engine/versions + +## Reporting a Vulnerability + +If you find any potential vulnerability, join our [discord](https://discord.gg/tUFFk9Y) channel +and contact anyone in the _@boa_dev_ group (check the yellow usernames). Explain how to trigger +the vulnerability, where can it be found and any recommendation you might have to fix it. diff --git a/boa_ast/src/lib.rs b/boa_ast/src/lib.rs index 5d1dd7663b9..d247fa04cb4 100644 --- a/boa_ast/src/lib.rs +++ b/boa_ast/src/lib.rs @@ -28,9 +28,9 @@ //! //! [grammar]: https://tc39.es/ecma262/#sec-syntactic-grammar //! [early]: https://tc39.es/ecma262/#sec-static-semantic-rules -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", diff --git a/boa_engine/src/lib.rs b/boa_engine/src/lib.rs index 023968e80d9..2cb02a5440f 100644 --- a/boa_engine/src/lib.rs +++ b/boa_engine/src/lib.rs @@ -25,9 +25,9 @@ //! //! [whatwg]: https://console.spec.whatwg.org //! [ecma-402]: https://tc39.es/ecma402 -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", diff --git a/boa_gc/src/lib.rs b/boa_gc/src/lib.rs index dc207ffe029..941f003113f 100644 --- a/boa_gc/src/lib.rs +++ b/boa_gc/src/lib.rs @@ -20,9 +20,9 @@ //! - **`boa_unicode`** - Boa's Unicode identifier. //! - **`boa_icu_provider`** - Boa's ICU4X data provider. //! -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", diff --git a/boa_interner/src/lib.rs b/boa_interner/src/lib.rs index 8e6d98d1277..3088b859e44 100644 --- a/boa_interner/src/lib.rs +++ b/boa_interner/src/lib.rs @@ -25,9 +25,9 @@ //! - **`boa_unicode`** - Boa's Unicode identifier. //! - **`boa_icu_provider`** - Boa's ICU4X data provider. //! -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", diff --git a/boa_parser/src/lib.rs b/boa_parser/src/lib.rs index df92ae5d1dc..2a03c371f68 100644 --- a/boa_parser/src/lib.rs +++ b/boa_parser/src/lib.rs @@ -24,9 +24,9 @@ //! [spec]: https://tc39.es/ecma262 //! [lex]: https://tc39.es/ecma262/#sec-ecmascript-language-lexical-grammar //! [grammar]: https://tc39.es/ecma262/#sec-ecmascript-language-expressions -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", diff --git a/boa_profiler/src/lib.rs b/boa_profiler/src/lib.rs index c57b2fba61b..4e6d89c7ccd 100644 --- a/boa_profiler/src/lib.rs +++ b/boa_profiler/src/lib.rs @@ -21,9 +21,9 @@ //! - **`boa_icu_provider`** - Boa's ICU4X data provider. //! //! [profiler-md]: https://github.com/boa-dev/boa/blob/main/docs/profiling.md -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", diff --git a/boa_unicode/src/lib.rs b/boa_unicode/src/lib.rs index 4b7be57be91..9d90dda9e58 100644 --- a/boa_unicode/src/lib.rs +++ b/boa_unicode/src/lib.rs @@ -26,9 +26,9 @@ //! - **`boa_icu_provider`** - Boa's ICU4X data provider. //! //! [uax31]: http://unicode.org/reports/tr31 -//! [boa-conformance]: https://boa-dev.github.io/boa/test262/ -//! [boa-web]: https://boa-dev.github.io/ -//! [boa-playground]: https://boa-dev.github.io/boa/playground/ +//! [boa-conformance]: https://boajs.dev/boa/test262/ +//! [boa-web]: https://boajs.dev/ +//! [boa-playground]: https://boajs.dev/boa/playground/ #![doc( html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg", From ab4408243a4136eed03964bef6b2e4b08b6f99b2 Mon Sep 17 00:00:00 2001 From: Iban Eguia Moraza Date: Sat, 25 Mar 2023 22:22:14 +0100 Subject: [PATCH 2/2] Fixed typo --- SECURITY.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index de40c556cd4..4d882a6ea65 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,9 +2,9 @@ ## Supported Versions -Until we reach the 1.0 version, we only support the lates released 0.x version and the current -`main` branch. You can find the latest released version of Boa in the [GitHub releases][gh_releases] -page or on [crates.io][crate]. +Until we reach the 1.0 version, we only support the latest 0.x release and the current `main` +branch. You can find the latest release of Boa in the [GitHub releases][gh_releases] page or +on [crates.io][crate]. [gh_releases]: https://github.com/boa-dev/boa/releases [crate]: https://crates.io/crates/boa_engine/versions