Update CONTRIBUTING.md to mention linting tools #28141
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bsmth
reviewed
Jul 24, 2023
Co-authored-by: Brian Thomas Smith <[email protected]>
|
|
||
| If you have a [local checkout](#forking-and-cloning-the-repository) of the repository and have [installed the dependencies](#preparing-the-project), or you are using [github.dev](https://github.dev), a pre-commit hook will be installed which automatically runs while making a commit. To save some headache and improve your work flow, you may wish to [configure your editor to automatically run Prettier](https://prettier.io/docs/en/editors.html). Alternatively, you may run `yarn fix:md` in the command line to manually format all Markdown files. | ||
|
|
||
| > **Note:** Automatically formatting changes does not work for pull requests opened using the GitHub Web UI as described in the ["Simple changes" section](#simple-changes). This may result in failed status checks on pull requests. If you're not sure about how to fix this, [get in touch with us](https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels) for help. |
There was a problem hiding this comment.
Grrrrr. We should not have to write this. Any change you can make that can fail lint should auto-lint.
There was a problem hiding this comment.
Well, now Prettier formatting is no longer required to pass PR checks, so I guess this statement isn't valid any longer.
There was a problem hiding this comment.
Its not valid, but something similar might be useful. The linter still runs and gives warnings to add lines around code blocks and such that need to be fixed.
Co-authored-by: Hamish Willee <[email protected]>
dipikabh
approved these changes
Jul 25, 2023
There was a problem hiding this comment.
Thanks, @queengooborg! I got just one comment, but also leaving a +1.
Co-authored-by: Dipika Bhattacharya <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates
CONTRIBUTING.md, primarily to mention the linting tools that we use and how the contributor can use them as well. This also makes a few quality-of-life changes to the rest of the documentation.