diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d052203c..0ac5dbaf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,8 @@ Harper follows [conventional commit practices](https://www.conventionalcommits.o Before creating a pull request, please make sure all your commits follow the linked conventions. Additionally, to minimize the labor required to review your commit, we run a relatively strict suite of formatting and linting programs. -We highly recommend that you run both `format.sh` and `precommit.sh` before submitting a pull request. -If those scripts don't work in your environment, we run `precommit.sh` through GitHub actions inside of pull requests, so you may make modifications and push until the checks pass. +We highly recommend that you run both `just format` and `just precommit` before submitting a pull request. +If those scripts don't work in your environment, we run `just precommit` through GitHub actions inside of pull requests, so you may make modifications and push until the checks pass. If this sounds intimidating, don't worry. We are entirely willing to work with you to make sure your code can make it into Harper, just know it might take a little longer. diff --git a/packages/obsidian-plugin/README.md b/packages/obsidian-plugin/README.md index a1875c1a..aa8ba746 100644 --- a/packages/obsidian-plugin/README.md +++ b/packages/obsidian-plugin/README.md @@ -4,8 +4,8 @@ This directory contains the source code for the [Obsidian](https://obsidian.md/) ## Building -In order to build the plugin, you must first compile `harper-wasm` with: +In order to build the plugin, you may use `just` like so: ```bash -wasm-pack build --target web +just build-obsidian ```