2015-11-19 15:44:34 +00:00
|
|
|
# Contributing to Vault
|
|
|
|
|
|
2016-01-27 20:17:11 +00:00
|
|
|
**Please note:** We take Vault's security and our users' trust very seriously.
|
|
|
|
|
If you believe you have found a security issue in Vault, please responsibly
|
2015-11-19 15:44:34 +00:00
|
|
|
disclose by contacting us at security@hashicorp.com.
|
|
|
|
|
|
2016-01-27 20:17:11 +00:00
|
|
|
**First:** if you're unsure or afraid of _anything_, just ask or submit the
|
|
|
|
|
issue or pull request anyways. You won't be yelled at for giving it your best
|
|
|
|
|
effort. The worst that can happen is that you'll be politely asked to change
|
|
|
|
|
something. We appreciate any sort of contributions, and don't want a wall of
|
|
|
|
|
rules to get in the way of that.
|
2015-11-19 15:44:34 +00:00
|
|
|
|
2016-01-27 20:17:11 +00:00
|
|
|
That said, if you want to ensure that a pull request is likely to be merged,
|
|
|
|
|
talk to us! You can find out our thoughts and ensure that your contribution
|
|
|
|
|
won't clash or be obviated by Vault's normal direction. A great way to do this
|
2020-06-11 16:34:25 +00:00
|
|
|
is via the [Vault Discussion Forum][2].
|
2015-11-19 15:44:34 +00:00
|
|
|
|
2021-02-25 16:38:29 +00:00
|
|
|
## Issues
|
|
|
|
|
|
|
|
|
|
This section will cover what we're looking for in terms of reporting issues.
|
2016-01-27 20:17:11 +00:00
|
|
|
By addressing all the points we're looking for, it raises the chances we can
|
2015-11-19 15:44:34 +00:00
|
|
|
quickly merge or address your contributions.
|
|
|
|
|
|
|
|
|
|
### Reporting an Issue
|
|
|
|
|
|
|
|
|
|
* Make sure you test against the latest released version. It is possible
|
2016-01-27 20:17:11 +00:00
|
|
|
we already fixed the bug you're experiencing. Even better is if you can test
|
|
|
|
|
against `master`, as bugs are fixed regularly but new versions are only
|
|
|
|
|
released every few months.
|
2015-11-19 15:44:34 +00:00
|
|
|
|
|
|
|
|
* Provide steps to reproduce the issue, and if possible include the expected
|
2016-01-27 20:17:11 +00:00
|
|
|
results as well as the actual results. Please provide text, not screen shots!
|
|
|
|
|
|
|
|
|
|
* If you are seeing an internal Vault error (a status code of 5xx), please be
|
|
|
|
|
sure to post relevant parts of (or the entire) Vault log, as often these
|
|
|
|
|
errors are logged on the server but not reported to the user
|
2015-11-19 15:44:34 +00:00
|
|
|
|
|
|
|
|
* If you experienced a panic, please create a [gist](https://gist.github.com)
|
|
|
|
|
of the *entire* generated crash log for us to look at. Double check
|
|
|
|
|
no sensitive items were in the log.
|
|
|
|
|
|
|
|
|
|
* Respond as promptly as possible to any questions made by the Vault
|
2016-01-27 20:17:11 +00:00
|
|
|
team to your issue. Stale issues will be closed periodically.
|
2015-11-19 15:44:34 +00:00
|
|
|
|
|
|
|
|
### Issue Lifecycle
|
|
|
|
|
|
|
|
|
|
1. The issue is reported.
|
|
|
|
|
|
|
|
|
|
2. The issue is verified and categorized by a Vault collaborator.
|
|
|
|
|
Categorization is done via tags. For example, bugs are marked as "bugs".
|
|
|
|
|
|
2016-01-27 20:17:11 +00:00
|
|
|
3. Unless it is critical, the issue may be left for a period of time (sometimes
|
|
|
|
|
many weeks), giving outside contributors -- maybe you!? -- a chance to
|
|
|
|
|
address the issue.
|
2015-11-19 15:44:34 +00:00
|
|
|
|
|
|
|
|
4. The issue is addressed in a pull request or commit. The issue will be
|
|
|
|
|
referenced in the commit message so that the code that fixes it is clearly
|
|
|
|
|
linked.
|
|
|
|
|
|
|
|
|
|
5. The issue is closed. Sometimes, valid issues will be closed to keep
|
|
|
|
|
the issue tracker clean. The issue is still indexed and available for
|
|
|
|
|
future viewers, or can be re-opened if necessary.
|
|
|
|
|
|
2021-02-25 16:38:29 +00:00
|
|
|
## Pull requests
|
|
|
|
|
|
|
|
|
|
Please include a file within your PR named `changelog/#.txt`, where `#` is your
|
|
|
|
|
pull request ID. There are many examples under [changelog](changelog/), but
|
|
|
|
|
the general format is
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
```release-note:CATEGORY
|
|
|
|
|
COMPONENT: summary of change
|
|
|
|
|
```
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
CATEGORY is one of `security`, `change`, `feature`, `improvement`, or `bug`.
|
|
|
|
|
Your PR is almost certain to be one of `bug` or `improvement`, but don't
|
|
|
|
|
worry too much about getting it exactly right, we'll tell you if a change is
|
|
|
|
|
needed.
|
|
|
|
|
|
|
|
|
|
To determine the relevant component, consult [CHANGELOG](CHANGELOG.md) and pick
|
|
|
|
|
whichever one you see that seems the closest match.
|
|
|
|
|
|
|
|
|
|
You do not need to include the link at the end of the summary that appears in
|
|
|
|
|
CHANGELOG.md, those are generated automatically by the changelog-building
|
|
|
|
|
process.
|
|
|
|
|
|
2015-11-19 15:44:34 +00:00
|
|
|
## Setting up Go to work on Vault
|
|
|
|
|
|
|
|
|
|
If you have never worked with Go before, you will have to complete the
|
|
|
|
|
following steps listed in the README, under the section [Developing Vault][1].
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[1]: https://github.com/hashicorp/vault#developing-vault
|
2020-06-11 16:34:25 +00:00
|
|
|
[2]: https://discuss.hashicorp.com/c/vault
|
2019-10-16 21:42:13 +00:00
|
|
|
|
|
|
|
|
## Contributor License Agreement
|
|
|
|
|
|
|
|
|
|
We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution.
|
|
|
|
|
|
|
|
|
|
[Learn more about why HashiCorp requires a CLA and what the CLA includes](https://www.hashicorp.com/cla)
|
