Skip to content

Add section on domProps #7815

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add section on domProps #7815

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70fd957
Add section on domProps
nojaf Aug 29, 2025
0fca202
Update CONTRIBUTING.md
nojaf Aug 30, 2025
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 fails, 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:
Expand Down
Loading