Skip to content

Latest commit

聽

History

History
97 lines (72 loc) 路 3.86 KB

CONTRIBUTING.md

File metadata and controls

97 lines (72 loc) 路 3.86 KB
Raw

Contributing to step cli

We welcome contributions to step cli of any kind including documentation, themes, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, helping to manage issues, etc.

Table of Contents

Reporting Issues

If you believe you have found a defect in step cli or its documentation, use the GitHub issue tracker to report the problem. When reporting the issue, please provide the version of step cli in use (step version) and your operating system.

Asking Support Questions

Users and developers can ask questions on GitHub Discussions.

Code Contribution

step cli aims to become a fully featured toolkit for cryptographic primitives. We encourage all contributions that meet the following criteria:

  • fit naturally into a toolkit for creating and working with cryptographic primitives and higher order resources.
  • strive not to break existing functionality.
  • close or update an open step cli issue

Bug fixes are, of course, always welcome.

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, submit a PR :).

Code Contribution Guidelines

Because we want to create the best possible product for our users and the best contribution experience for our developers, we have a set of guidelines which ensure that all contributions are acceptable. The guidelines are not intended as a filter or barrier to participation. If you are unfamiliar with the contribution process, the Smallstep team will guide you in order to get your contribution in accordance with the guidelines.

To make the contribution process as seamless as possible, we ask for the following:

  • Go ahead and fork the project and make your changes. We encourage pull requests to allow for review and discussion of code changes.
  • When you鈥檙e ready to create a pull request, be sure to:
    • Sign the CLA.
    • Have test cases for the new code. If you have questions about how to do this, please ask in your pull request.
    • Run go fmt.
    • Add documentation if you are adding new features or changing functionality.
    • Squash your commits into a single commit. git rebase -i. It鈥檚 okay to force update your pull request with git push -f.
    • Follow the Git Commit Message Guidelines below.

Git Commit Message Guidelines

This blog article is a good resource for learning how to write good commit messages, the most important part being that each commit message should have a title/subject in imperative mood starting with a capital letter and no trailing period: "Return error on wrong use of the Paginator", NOT "returning some error."

Also, if your commit references one or more GitHub issues, always end your commit message body with See #1234 or Fixes #1234. Replace 1234 with the GitHub issue ID. The last example will close the issue when the commit is merged into master.

Please use a short and descriptive branch name, e.g. NOT "patch-1". It's very common but creates a naming conflict each time when a submission is pulled for a review.

An example:

Add step certificate install

Add a command line utility for installing (and uninstalling) certificates to the
local system truststores. This should help developers with local development
flows.

Fixes #75