Skip to content

Commit

Permalink
docs: more contributing docs touch-ups
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Nov 22, 2024
1 parent d4500ce commit c474de8
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,13 @@ To get started, run the `build` script to create a symlink with `package.json` (
npm run build
```

To run test commands, use `./bin/dev.js` instead of `rdme`. For example, if the command you're testing looks like this...
To run test commands, swap out `rdme` for `bin/dev.js`. For example:

```sh
# if the production command you're testing looks like this...
rdme openapi:validate __tests__/__fixtures__/ref-oas/petstore.json
```

... your local command will look like this:

```sh
# ... your local test command will look like this:
bin/dev.js openapi:validate __tests__/__fixtures__/ref-oas/petstore.json
```

Expand All @@ -32,7 +30,7 @@ npm run build
bin/run.js openapi:validate __tests__/__fixtures__/ref-oas/petstore.json
```

Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [MAINTAINERS.md](./MAINTAINERS.md).
Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [`MAINTAINERS.md`](./MAINTAINERS.md).

## Running GitHub Actions Locally 🐳

Expand Down

0 comments on commit c474de8

Please sign in to comment.