fix(CONTRIBUTING): use backticks in example code #7835
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Aviv Keller <me@aviv.sh>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the CONTRIBUTING.md file to use backticks in example code blocks instead of triple single quotes, aligning the examples with the actual syntax used by contributors.
- Updated markdown delimiters for code blocks
- Ensured consistency in example language markers for CommonJS and ES Modules
Comments suppressed due to low confidence (1)
CONTRIBUTING.md:378
- The use of four backticks for the markdown code block is unusual; please ensure that this convention is clearly documented in CONTRIBUTING.md so that contributors understand it is intentional.
+````md
github-actions
bot
removed
the
github_actions:pull-request
Contributor
|
Lighthouse Results
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #7835 +/- ##
==========================================
- Coverage 75.48% 75.46% -0.03%
==========================================
Files 101 101
Lines 8309 8309
Branches 218 218
==========================================
- Hits 6272 6270 -2
- Misses 2035 2037 +2
Partials 2 2 ☔ View full report in Codecov by Sentry. |
ovflowd
approved these changes
Jun 4, 2025
canerakdas
approved these changes
Jun 4, 2025
Member
You mean you're requesting fast-tracking right? |
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 file is (hopefully) the first thing a contributor is going to read, so we should use the actual syntax that they will need to know when contributing.
I'm fast tracking this, so merge when ready