From 70fd957ec85a8e594cd295150c5144b1eb843106 Mon Sep 17 00:00:00 2001 From: nojaf Date: Fri, 29 Aug 2025 14:21:21 +0200 Subject: [PATCH 1/2] Add section on domProps --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc0d9df4c1..5e60bded44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -339,6 +339,36 @@ To generate the html: ../scripts/ninja docs ``` +## Contribute to JSX `domProps` + +The `domProps` type, defined in [packages/@rescript/runtime/JsxDOM.res](packages/@rescript/runtime/JsxDOM.res), dictates which properties can be used on DOM elements. This list isn't exhaustive, so you might want to contribute a missing prop. + +Adding a new entry there requires re-running the analysis tests. Follow these steps: + +1. Compile your changes: + ```bash + make lib + ``` +2. (Optional) If your local compiler is outdated, rebuild: + ```bash + make build + ``` +3. Run the analysis tests. This will likely fail due to an outdated autocomplete test snapshot: + ```bash + make test-analysis + ``` +4. Add the updated snapshot to Git: + ```bash + git add tests/analysis_tests + ``` +5. Re-run the analysis tests. They should now pass: + ```bash + make test-analysis + ``` + +(If a `make` command fail, consider using the [DevContainer](#b-devcontainer).) + +Finally, add a line to [CHANGELOG.md](CHANGELOG.md), using the `#### :nail_care: Polish` section. ## Code structure The highlevel architecture is illustrated as below: From 0fca2023398dae6bdd7e17b8616427e091b4c4d9 Mon Sep 17 00:00:00 2001 From: Florian Verdonck Date: Sat, 30 Aug 2025 19:26:51 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Médi-Rémi Hashim <4295266+mediremi@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e60bded44..78223e7ec4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -366,7 +366,7 @@ Adding a new entry there requires re-running the analysis tests. Follow these st make test-analysis ``` -(If a `make` command fail, consider using the [DevContainer](#b-devcontainer).) +(If a `make` command fails, consider using the [DevContainer](#b-devcontainer).) Finally, add a line to [CHANGELOG.md](CHANGELOG.md), using the `#### :nail_care: Polish` section. ## Code structure