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

Update contributing guidelines (#11917)

This commit is contained in:
Vishal Nayak 2021-06-22 14:06:34 -04:00 committed by GitHub
parent bbfd450319
commit 12e5f5045e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -24,24 +24,24 @@ quickly merge or address your contributions.
### 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 we
we already fixed the bug you're experiencing. Even better is if you can test 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 against the `main` branch, as the bugs are regularly fixed but new versions
released every few months. are only released every few months.
* Provide steps to reproduce the issue, and if possible include the expected * Provide steps to reproduce the issue, and if possible include the expected
results as well as the actual results. Please provide text, not screen shots! 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 * 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 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 errors are logged on the server but not reported to the user.
* If you experienced a panic, please create a [gist](https://gist.github.com) * 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 of the *entire* generated crash log for us to look at. Double check
no sensitive items were in the log. no sensitive items were in the log.
* Respond as promptly as possible to any questions made by the Vault * Respond as promptly as possible to any questions made by the Vault
team to your issue. Stale issues will be closed periodically. team to your issue.
### Issue Lifecycle ### Issue Lifecycle
@ -58,9 +58,14 @@ quickly merge or address your contributions.
referenced in the commit message so that the code that fixes it is clearly referenced in the commit message so that the code that fixes it is clearly
linked. linked.
5. The issue is closed. Sometimes, valid issues will be closed to keep 5. The issue is closed.
the issue tracker clean. The issue is still indexed and available for
future viewers, or can be re-opened if necessary. 6. Issues that are not reproducible and/or not gotten responses for a long time are
stale issues. In order to provide faster responses and better engagement with
the community, we strive to keep the issue tracker clean and the issue count
low. In this regard, our current policy is to close stale issues after 30 days.
Closed issues will still be indexed and available for future viewers. If users
feel that the issue is still relevant, we encourage reopening them.
## Pull requests ## Pull requests