Skip to content

Commit 56f7cd9

Browse files
committed
docs: utilize GitHub markdown alerts
1 parent 1042153 commit 56f7cd9

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
44

5-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
5+
> [!IMPORTANT]
6+
> This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project
7+
> you agree to abide by its terms.
68
79
## Setup
810

@@ -85,14 +87,11 @@ We'd also love PRs. If you're thinking of a large PR, we advise opening up an is
8587
5. Push to your fork, and submit a pull request
8688
6. Pat your self on the back and wait for your pull request to be reviewed and merged.
8789

88-
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
89-
90-
- Ensure you write and/or update tests to match the new/modified functionality
91-
- Keep your PR as focused as possible, avoid PRs that add multiple unrelated features or fix multiple bugs at once
92-
- Keep your PR as small as possible, to make reviewing easier and faster
93-
- Provide any and all necessary information in the PR description to help reviewers understand the context and impact of your change.
94-
- Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you
95-
- Make sure you use GitHub's "Draft PR" feature for these
90+
> [!TIP]
91+
> To increase the likelihood of your pull request being accepted, follow these guidelines:
92+
> - Add/update tests
93+
> - Avoid unrelated changes, stay focused
94+
> - Keep your PR as small as possible, to make reviewing easier and faster
9695
9796
### Merging strategy
9897

0 commit comments

Comments
 (0)