-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add contributors guide (#1) * Update README.md * Update README.md * Create CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Fix tiny typo in README * Update CONTRIBUTING.md * Update CONTRIBUTING.md
- Loading branch information
1 parent
0c9fcd6
commit a997ed4
Showing
2 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# 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](https://github.com/harness/harness-cli/issues). | ||
|
||
### Code contributions | ||
|
||
To propose a change to the codebase, open a [pull request](https://github.com/harness/harness-cli/pulls). 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](https://apidocs.harness.io/). Most functionality requires authentication to a Harness account (SaaS or self-managed). You can sign up for a free account [here](https://app.harness.io/auth/#/signup?utm_source=harness_io&utm_medium=cta&utm_campaign=platform&utm_content=main_nav). | ||
|
||
### Build and test locally | ||
1. Ensure you have Go version 1.19 or later [installed](https://go.dev/doc/install). | ||
2. [Fork](https://github.com/harness/harness-cli/fork) this repository, then [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) locally. | ||
3. Navigate into the project directory. | ||
```shell | ||
cd harness-cli/ | ||
``` | ||
4. Make your desired changes to the source code. | ||
5. From the `harness-cli/` directory, compile a new executable with your changes. | ||
```shell | ||
go build -o harness | ||
``` | ||
6. Run and test your changes. | ||
```shell | ||
./harness [global options] command [command options] [arguments...] | ||
``` | ||
7. If contributing, push to your fork and [submit a pull request](https://github.com/harness/harness-cli/pulls). Include relevant output and/or screenshots from local tests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters