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

update recommended reading section in contributing.md

Browse source
This commit is contained in:
alexvcs 2025-03-11 15:46:21 -04:00
parent 75aae02fa5
commit 54e61caced
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -35,13 +35,15 @@ 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.
[!RECOMMENDED READING]
:::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/)
:::
### Versioning
Pomerium uses [Semantic Versioning](https://semver.org/). In practice, this means for a given version number **vMAJOR**.**MINOR**.**PATCH** (for example, `v0.1.0`):