forked from
npmx.dev/npmx.dev
[READ-ONLY]
a fast, modern browser for the npm registry
docs: update guidance on file formatting (#523)
authored by
Salma Alam-Naylor
and committed by
GitHub
6b93e22f
485cc9ca
+6
+6
CONTRIBUTING.md
+6
CONTRIBUTING.md
···
105
105
106
106
## Code style
107
107
108
+
When committing changes, try to keep an eye out for unintended formatting updates. These can make a pull request look noisier than it really is and slow down the review process. Sometimes IDEs automatically reformat files on save, which can unintentionally introduce extra changes.
109
+
110
+
To help with this, the project uses `oxfmt` to handle formatting via a pre-commit hook. The hook will automatically reformat files when needed. If something can’t be fixed automatically, it will let you know what needs to be updated before you can commit.
111
+
112
+
If you want to get ahead of any formatting issues, you can also run `pnpm lint:fix` before committing to fix formatting across the whole project.
113
+
108
114
### Typescript
109
115
110
116
- We care about good types – never cast things to `any` 💪