luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Document changelog fragment format. (#11004)

This commit is contained in:
Nick Cabatoff 2021-02-25 11:38:29 -05:00 committed by GitHub
parent 6d2eb44c14
commit 507d70a07f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@ -15,12 +15,12 @@ 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 won't clash or be obviated by Vault's normal direction. A great way to do this
is via the [Vault Discussion Forum][2]. is via the [Vault Discussion Forum][2].
This document will cover what we're looking for in terms of reporting issues. ## Issues
This section will cover what we're looking for in terms of reporting issues.
By addressing all the points we're looking for, it raises the chances we can By addressing all the points we're looking for, it raises the chances we can
quickly merge or address your contributions. quickly merge or address your contributions.
## Issues
### Reporting an Issue ### Reporting an Issue
* Make sure you test against the latest released version. It is possible * Make sure you test against the latest released version. It is possible
@ -61,6 +61,30 @@ quickly merge or address your contributions.
the issue tracker clean. The issue is still indexed and available for the issue tracker clean. The issue is still indexed and available for
future viewers, or can be re-opened if necessary. future viewers, or can be re-opened if necessary.
## 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.
## Setting up Go to work on Vault ## Setting up Go to work on Vault
If you have never worked with Go before, you will have to complete the If you have never worked with Go before, you will have to complete the