From 2d74a66cac2ff8e3541e938d433a01d9eca73d0c Mon Sep 17 00:00:00 2001 From: alexvcs Date: Tue, 11 Mar 2025 15:51:32 -0400 Subject: [PATCH] switch to github note special markdown syntax --- CONTRIBUTING.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef1a25720..6370a6d8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,14 +35,12 @@ Here are some of the expectations we have of contributors: - **Use comments properly.** We expect good godoc comments for package-level functions, types, and values. Comments are also useful whenever the purpose for a line of code is not obvious. -:::info **Recommended reading** - -- [**CodeReviewComments**](https://github.com/golang/go/wiki/CodeReviewComments) -- [**Linus Torvalds describes a good commit message**](https://gist.github.com/matthewhudson/1475276) -- [**Best Practices for Maintainers**](https://opensource.guide/best-practices/) -- [**Shrinking Code Review**](https://alexgaynor.net/2015/dec/29/shrinking-code-review/) - -::: +> [!NOTE] +> +> - [**CodeReviewComments**](https://github.com/golang/go/wiki/CodeReviewComments) +> - [**Linus Torvalds describes a good commit message**](https://gist.github.com/matthewhudson/1475276) +> - [**Best Practices for Maintainers**](https://opensource.guide/best-practices/) +> - [**Shrinking Code Review**](https://alexgaynor.net/2015/dec/29/shrinking-code-review/) ### Versioning