Skip to content

Commit 846f3f3

Browse files
authored
Merge pull request #137 from tmr232/update-contributing-md
Update linting docs
2 parents 1af6520 + ed6ce15 commit 846f3f3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,17 @@ We use multiple tools to format and lint our code, including automatic fixes by
8383
To run the tools, use:
8484

8585
```shell
86-
bun check
86+
bun lint
8787
```
8888

8989
The command will run both formatting & linting, and stop when a tool detects issues it cannot resolve automatically.
9090
Follow the recommendation in the tool output, and re-run the command once you are done.
9191

9292
We recommend running it frequently as you code to keep the output short and simple.
9393

94+
If you see changes to files you did not edit - try running `bun install` again,
95+
as the linters and the configuration get updated from time to time.
96+
9497

9598
### Update CHANGELOG and CONTRIBUTORS
9699

@@ -124,4 +127,4 @@ There may be some discussion and, in most cases, a few iterations will be requir
124127

125128
When the pull request is approved, it will be merged into the `main` branch.
126129
Your change will be immediately available in the [online demo](https://tmr232.github.io/function-graph-overview/),
127-
and will be available in the IDE plugins on the next release.
130+
and will be available in the IDE plugins on the next release.

0 commit comments

Comments
 (0)