-
Notifications
You must be signed in to change notification settings - Fork 656
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update CONTRIBUTING.md and issue templates (#311)
Update CONTRIBUTING.md: * A more friendly approach, hopefully. * The note about receiving patches is moved to the DCO section. * Some "Get started" links in a bullet list (inspired by OpenTofu's contributing file). * For questions, refer to GitHub Discussions and Discord instead of only Discord. * Minor edits and formatting. Update issue templates: * The issue template for questions is replaced by a link to Discussions and to Matrix and Discord chats. * Add a link to the valkey-doc repo. * The crash report template is extended into a form, with separate fields for the crash report and the additional info. --------- Signed-off-by: Viktor Söderqvist <[email protected]>
- Loading branch information
1 parent
c090874
commit 10d9808
Showing
6 changed files
with
72 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Questions? | ||
url: https://github.com/valkey-io/valkey/discussions | ||
about: Ask and answer questions on GitHub Discussions. | ||
- name: Chat with us on Discord? | ||
url: https://discord.gg/zbcPa5umUB | ||
about: We are on Discord! | ||
- name: Chat with us on Matrix? | ||
url: https://matrix.to/#/#valkey:matrix.org | ||
about: We are on Matrix too! | ||
- name: Documentation issue? | ||
url: https://github.com/valkey-io/valkey-doc/issues | ||
about: Report it on the valkey-doc repo. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
name: Crash report | ||
description: Submit a crash report | ||
title: '[CRASH] <short description>' | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to post your crash report! | ||
Please notice: | ||
- If a module was involved, please open an issue in the module's repo instead! | ||
- If you're using docker on Apple M1, please make sure the image you're using was compiled for ARM! | ||
- type: textarea | ||
id: crash-report | ||
attributes: | ||
label: Crash report | ||
description: Paste the complete crash log. Please include a few lines from the log preceding the crash report to provide some context. | ||
render: shell | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please provide the following additional information below: | ||
- OS distribution and version | ||
- Steps to reproduce (if any) | ||
- type: textarea | ||
id: additional-information | ||
attributes: | ||
label: Additional information | ||
description: OS version, steps to reproduce and other useful info. | ||
render: shell | ||
validations: | ||
required: false |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters