Skip to content
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

Jump to bottom

doc(dev): Add CONTRIBUTING.md section about updating vendored submodules #802

Merged
merged 1 commit into from
Oct 21, 2023
Merged

doc(dev): Add CONTRIBUTING.md section about updating vendored submodules #802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,19 @@ Here are some common commands you may find useful:
- `dune runtest` runs the native tests
- `dune exec jscomp/main/melc.exe` is useful to run the development version of `melc`

### Updating the `vendor/melange-compiler-libs` submodule:

1. Make your change in
[`vendor/melange-compiler-libs`](./vendor/melange-compiler-libs)
2. Commit to your fork of the [`melange-compiler-libs`
repo](https://github.com/melange-re/melange-compiler-libs) and get a PR
through
3. Commit the updated branch to the submodule in this repository
4. To make it build in CI, change the `melange-compiler-libs` input URL in
[flake.nix](https://github.com/melange-re/melange/blob/9597451da4c83fd6ba937e4592941b7cb18b45e8/flake.nix#L14)
(if necessary, e.g. to point to an unmerged branch), then run `nix flake
update` and commit the modified `flake.lock`

## Submitting a Pull Request

When you are almost ready to open a PR, it's a good idea to run the full CI test suite locally to make sure everything works. First, open a new non-`nix` shell or exit your current `nix` shell by using the `exit` command or `CTRL+D`. Then, run the following command:
Expand Down