[Docs] Recommend prettier-fix
in PR template and contribution guide (#51237)
Recommend running `prettier-fix` before opening docs PRs to fix formatting issues. I've found that `lint-fix` is currently not fixing formatting issues. Related: https://vercel.slack.com/archives/C03S9JCH2Q5/p1686647582580629
This commit is contained in:
parent
0840793abf
commit
e048f4ef03
2 changed files with 2 additions and 2 deletions
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
|
@ -6,6 +6,7 @@ Choose the right checklist for the change(s) that you're making:
|
|||
|
||||
### Improving Documentation
|
||||
|
||||
- Run `pnpm prettier-fix` to fix formatting issues before opening the PR.
|
||||
- Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide
|
||||
|
||||
### Adding or Updating Examples
|
||||
|
@ -29,7 +30,6 @@ Choose the right checklist for the change(s) that you're making:
|
|||
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md
|
||||
|
||||
|
||||
|
||||
## For Maintainers
|
||||
|
||||
- Minimal description (aim for explaining to someone not on the team to understand the PR)
|
||||
|
|
|
@ -62,7 +62,7 @@ Once you've submitted your contribution, the Next.js or Developer Experience tea
|
|||
|
||||
Please let us know if you have any questions or need further assistance in your PR's comments. Thank you for contributing to the Next.js docs and being a part of our community!
|
||||
|
||||
> **Tip:** Run `pnpm lint-fix` to automatically fix Prettier and ESLint errors before submitting your PR.
|
||||
> **Tip:** Run `pnpm prettier-fix` to run Prettier before submitting your PR.
|
||||
|
||||
## File Structure
|
||||
|
||||
|
|
Loading…
Reference in a new issue