mirror of
https://github.com/smallstep/cli.git
synced 2025-04-19 10:42:15 +03:00
Update contribution and local development guides
This commit is contained in:
parent
9d7ece2157
commit
832bd0699b
@ -82,6 +82,7 @@ Here's a quick example, combining `step oauth` and `step crypto` to get and veri
|
||||
|
||||
* Connect with `step` users on [GitHub Discussions](https://github.com/smallstep/certificates/discussions) or [Discord](https://bit.ly/step-discord)
|
||||
* [Open an issue](https://github.com/smallstep/cli/issues/new/choose) and tell us what features you'd like to see
|
||||
* [Contribute](./docs/CONTRIBUTING.md) to the `step` codebase
|
||||
* [Follow Smallstep on Twitter](https://twitter.com/smallsteplabs)
|
||||
|
||||
## Further Reading
|
||||
|
@ -7,9 +7,11 @@ to manage issues, etc.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Asking Support Questions](#asking-support-questions)
|
||||
* [Reporting Issues](#reporting-issues)
|
||||
* [Submitting Patches](#submitting-patches)
|
||||
* [Asking Support Questions](#asking-support-questions)
|
||||
* [Code Contribution](#code-contribution)
|
||||
* [Local Development](#local-development)
|
||||
* [Submitting Patches](#submitting-patches)
|
||||
* [Code Contribution Guidelines](#code-contribution-guidelines)
|
||||
* [Git Commit Message Guidelines](#git-commit-message-guidelines)
|
||||
|
||||
@ -18,8 +20,7 @@ to manage issues, etc.
|
||||
If you believe you have found a defect in `step cli` or its
|
||||
documentation, use the GitHub [issue
|
||||
tracker](https://github.com/smallstep/cli/issues) to report the
|
||||
problem. When reporting the issue, please provide the version of `step
|
||||
cli` in use (`step version`) and your operating system.
|
||||
problem. When reporting the issue, please provide the version of `step` CLI in use (`step version`) and your operating system.
|
||||
|
||||
## Asking Support Questions
|
||||
|
||||
@ -37,7 +38,11 @@ primitives and higher order resources.
|
||||
|
||||
**Bug fixes are, of course, always welcome.**
|
||||
|
||||
## Submitting Patches
|
||||
### Local Development
|
||||
|
||||
Check out the [local development](./local-development.md) guide for instructions for working on the `step` CLI code.
|
||||
|
||||
### Submitting Patches
|
||||
|
||||
`step cli` welcomes all contributors and contributions. If you are
|
||||
interested in helping with the project, please reach out to us or, better yet,
|
||||
|
@ -15,6 +15,8 @@ To get started with local development, you will need three things:
|
||||
|
||||
- Golang installed locally (instructions available
|
||||
[here](https://golang.org/doc/install)).
|
||||
- We follow the general Go support timeline, meaning the latest two versions
|
||||
of Go are supported. See `go.mod` for the current minimum version.
|
||||
- A version of `make` available for usage of the `Makefile`.
|
||||
- The repository checked out in the appropriate location of your `$GOPATH`.
|
||||
|
||||
@ -40,7 +42,7 @@ binary in the `bin` folder.
|
||||
### Running Tests and Linting
|
||||
|
||||
Now that you've installed any dependencies, you can run the tests and lint the
|
||||
code base simply by running `make`.
|
||||
codebase simply by running `make`.
|
||||
|
||||
#### Unit Tests
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user