Skip to content

Commit

Permalink
Add versioning section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikPelli committed Dec 27, 2024
1 parent 0838ab2 commit 6171032
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,18 @@ aren't sure about it).
Make sure to include the bin folder in the path of your shell, to be able to
directly use the `golangci-lint run` command.

## Versioning
With GitHub, there are 2 version types: release versions (such as `v1.x`)
and Go branch default versions (such as `v0.0.0-202412xxx`).
The latter is `automatically` assigned by Go modules command if the
master branch contains new commits that aren't present in the last
GitHub release.

We plan to `periodically` publish stable releases (v1.x), after a while that
no one reports issues with the fixes merged in the master branch.
You can `safely use both` version types, since we carefully review
all the pull requests before merging them.

## A taste of GoProxy

To get a taste of `goproxy`, here you are a basic HTTP/HTTPS proxy
Expand Down

0 comments on commit 6171032

Please sign in to comment.