Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (54 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

84 lines (54 loc) · 3.27 KB

Contributing

Authorization Proxy uses GitHub to manage reviews of pull requests.

Steps to Contribute

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.

For quickly compiling and testing your changes, do:

# for building
go build
./authorization-proxy

# for testing (Make sure all the tests pass before you commit and push :))
make test

Pull Request Process

  • Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.
    • Branches should have descriptive names and start with prefixes like patch/, fix/, feature/. Good examples are: fix/vulnerability-issue or feature/issue-templates.
  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.
  • Add tests relevant to the fixed bug or new feature.
  • Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  • Please use Squash and merge to merge a PR.
  • For release, check out the following: About release

Dependency management

The Authorization Proxy project uses Go modules to manage dependencies on external packages. This requires a working Go environment with version 1.23 or greater installed.

To add or update a new dependency, use the go get command:

# Pick the latest tagged release.
go get example.com/some/module/pkg

# Pick a specific version.
go get example.com/some/module/pkg@vX.Y.Z

Tidy up the go.mod and go.sum files:

# The GO111MODULE variable can be omitted when the code isn't located in GOPATH.
GO111MODULE=on go mod tidy

You have to commit the changes to go.mod and go.sum before submitting the pull request.

About release

This section describes how to release a new version of the Authorization Proxy.

How to release

Tip

For consistent release DX, please refrain from creating a tag with git command

Note

Please note that:

  • latest tag will be updated as well
  • there is no pr tag release

Create a release with GitHub UI from the following: https://github.com/AthenZ/authorization-proxy/releases

draft_a_new_release

Architecture: Release Pipeline

Here is a general architecture of the current release pipeline:

release_pipeline_architecture

Contributor Covenant Code of Conduct

Attribution