Skip to content

Update CONTRIBUTING.md #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2025
Merged

Update CONTRIBUTING.md #612

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@ Please make sure that you have Prettier installed and working locally: <https://

There is a GitHub action that checks pull-requests for valid formatting.

For paragraphs containing multiple sentences, please start each sentence on a new line.
Doing that produces cleaner diffs for future code reviews.
The sentences will still be rendered as a continuous paragraph.
For an example, have a look at the code for this paragraph.

### Admonitions

We use admonitions extensively to make certain pieces of content stand out.
Expand Down