Skip to content

Commit

Permalink
feat: updated docs to use just
Browse files Browse the repository at this point in the history
  • Loading branch information
elijah-potter committed Jul 7, 2024
1 parent 66da0b2 commit d34ad9b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions packages/obsidian-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit d34ad9b

Please sign in to comment.