Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (61 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

95 lines (61 loc) · 3.88 KB

Contributing to doco-cd

Thank you for your support. Help is always appreciated!

Have an issue, idea or question?

Want to contribute your code?

Required tools

The following tools need to be installed:

  • A IDE/Editor of your choice
  • Git
  • Golang (see the go.mod file for the currently used version.
  • Make

Additional steps

Follow the installation instructions for the following dependencies:

  • Bitwarden Go SDK (optional, only required if you're building with Bitwarden support. Not required when building with the nobitwarden build tag)

Getting started

  1. Set up Git Commit Signing if you haven't already done so. Please always sign your commits!
  2. Clone the repository.
  3. In the cloned repo, execute make tools on your command line to download/install the Go tool binaries (like linters and formatters).

Coding style

Please follow these guidelines when contributing code:

  • Write comments and documentation where necessary.
  • Follow Go best practices and conventions. Refer to the Effective Go guide for more information.
  • Write unit tests for your code that cover various scenarios and edge cases including error cases if applicable.
  • Write clear, concise, and descriptive commit messages and use conventional commits.
  • Always sign your commits. See Signing commits for more information.

Testing

After you wrote your code, run make fmt to format and lint your code. Adjust your code accordingly to the proposals of the linter output. The CI pipeline will fail, if the code is not formatted correctly.

Always add unit tests to verify your code. Run the tests with make test or make test-verbose and run specific tests with make test-run <testName> (Verbose with make test-run "-v <testName>").

With registry credentials

You can provide container registry credentials to avoid rate limiting issues when running tests.

Follow the Accessing private container registries Guide in the Wiki for more information.

Building from Source

Create a .env file and add any environment variables required for your development environment.

For example

GIT_ACCESS_TOKEN=xxx
WEBHOOK_SECRET=test_secret
SOPS_AGE_KEY=AGE-SECRET-KEY-xxx
APPRISE_NOTIFY_URLS=xxx
API_SECRET=xxx

Run the following command to build and run the doco-cd dev container:

docker compose -f dev.compose.yaml up --build

Building without Bitwarden support

If you want to build the project without Bitwarden Secrets Manager support (e.g., for armv7 architecture where Bitwarden SDK is not compatible), use the nobitwarden build tag:

CGO_ENABLED=0 go build -tags nobitwarden -o doco-cd ./cmd/doco-cd

Or using Docker with the DISABLE_BITWARDEN=true build argument:

docker build --build-arg DISABLE_BITWARDEN=true -t doco-cd:nobitwarden .

Submitting your code

  1. Commit your changes with a descriptive commit message, following the conventional commits specification.
  2. Push your changes to your fork/branch.
  3. Open a pull request against the main branch of this repository and provide a clear description of your changes.