3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-05-01 03:16:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

switch to github note special markdown syntax

Browse source
This commit is contained in:
alexvcs 2025-03-11 15:51:32 -04:00
parent 54e61caced
commit 2d74a66cac
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.md
View file

@ -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. - **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** > [!NOTE]
>
- [**CodeReviewComments**](https://github.com/golang/go/wiki/CodeReviewComments) > - [**CodeReviewComments**](https://github.com/golang/go/wiki/CodeReviewComments)
- [**Linus Torvalds describes a good commit message**](https://gist.github.com/matthewhudson/1475276) > - [**Linus Torvalds describes a good commit message**](https://gist.github.com/matthewhudson/1475276)
- [**Best Practices for Maintainers**](https://opensource.guide/best-practices/) > - [**Best Practices for Maintainers**](https://opensource.guide/best-practices/)
- [**Shrinking Code Review**](https://alexgaynor.net/2015/dec/29/shrinking-code-review/) > - [**Shrinking Code Review**](https://alexgaynor.net/2015/dec/29/shrinking-code-review/)
:::
### Versioning ### Versioning