Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.8 KB
Raw

Contributing to the Harness CLI

Thank you for considering contributing to the Harness CLI! Contributions fall into a couple of categories:

Bugs and feature requests

To report a bug or request a feature enhancement, create a GitHub issue.

Code contributions

To propose a change to the codebase, open a pull request. A maintainer will be happy to triage and ask clarifying questions as needed. We also ask that you build and test proposed changes yourself, and include any relevant output and/or screenshots in the PR.

Development

The Harness CLI is a Go module that interacts heavily with the Harness API. Most functionality requires authentication to a Harness account (SaaS or self-managed). You can sign up for a free account here.

Build and test locally

  1. Ensure you have Go version 1.19 or later installed.
  2. Fork this repository, then clone locally.
  3. Navigate into the project directory.
 cd harness-cli/
  1. Make your desired changes to the source code.
  2. From the harness-cli/ directory, compile a new executable with your changes.
 go build -o harness
  1. Run and test your changes.
./harness [global options] command [command options] [arguments...]
  1. If contributing, push to your fork and submit a pull request. Include relevant output and/or screenshots from local tests.