From 4167ccf059499b2cfcf5e96fdcced9df47b772b8 Mon Sep 17 00:00:00 2001 From: Guillaume Belanger Date: Wed, 31 Jan 2024 14:18:46 -0500 Subject: [PATCH] chore: Add github templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ++++++++++++++++++++++++++++ .github/pull_request_template.md | 12 +++++++++ CONTRIBUTING.md | 13 ++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..fbe1c21c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: "" +labels: ["bug"] +assignees: '' +--- + +#### Describe the bug + + +#### To Reproduce + + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +#### Expected behavior + + +#### Screenshots + + +#### Logs + + +#### Environment + +- Snap revision: +- Snap channel: +- Vault version: +- Ubuntu version: + +#### Additional context + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..e6cf2e45f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +# Description + +Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change. + +# Checklist: + +- [ ] My code follows the [style guidelines](/CONTRIBUTING.md) of this project +- [ ] I have performed a self-review of my own code +- [ ] I have made corresponding changes to the documentation +- [ ] I have added tests that validate the behaviour of the software +- [ ] I validated that new and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..16debec81 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +Install snapcraft: + +```bash +sudo snap install snapcraft --classic +``` + +Build the snap: + +```bash +snapcraft pack --verbose +```