diff options
author | Pavel Tikhomirov <ptikhomirov@virtuozzo.com> | 2021-05-29 10:19:49 +0300 |
---|---|---|
committer | Andrei Vagin <avagin@gmail.com> | 2021-09-03 20:31:00 +0300 |
commit | d0511319e5edb1f05683600cc2279dc47725b352 (patch) | |
tree | dabd86e20ab2621cb6a6f2a217d6495222acf1be /.github | |
parent | 3c10d3335bafaad211d92a0b88c27144fe349d25 (diff) |
github: Add templates for new issues and pull requests
This way users would be able to create more meaningfull pull-requests
and issues. And we would not need to ask them to provide basic
information each time.
Signed-off-by: Pavel Tikhomirov <ptikhomirov@virtuozzo.com>
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 63 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 18 |
2 files changed, 81 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..222d66156 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,63 @@ +<!-- +Before reporting a new issue, please make sure that it's not a duplicate. + +If you suspect your issue is a bug, please provide information as shown below. If your issue is a feature request, this information is not always necessary. +--> + +**Description** + +<!-- +Briefly describe the problem you are having in a few paragraphs. +--> + +**Steps to reproduce the issue:** +1. +2. +3. + +**Describe the results you received:** + + +**Describe the results you expected:** + + +**Additional information you deem important (e.g. issue happens only occasionally):** + + +**CRIU logs and information:** + +<!-- +You can either attach logs as files to the issue or put them under details +--> + +<details><summary>CRIU full dump/restore logs:</summary> +<p> + +``` +(paste your output here) +``` + +</p> +</details> + +<details><summary>Output of `criu --version`:</summary> +<p> + +``` +(paste your output here) +``` + +</p> +</details> + +<details><summary>Output of `criu check --all`:</summary> +<p> + +``` +(paste your output here) +``` + +</p> +</details> + +**Additional environment details:** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..62365b191 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +<!-- +Please make sure you've read and understood our contributing guidelines: +https://github.com/checkpoint-restore/criu/blob/criu-dev/CONTRIBUTING.md + +In short you need to: + +- Describe What you do and How you do it; +- Separate each logical change into a separate commit; +- Add a "Signed-off-by:" line identifying that you certify your work with DCO; +- If you fix some specific bug or commit, please add "Fixes: ..." line; +- Review fixes should be made by amending the original commits. For example: + a) fix the code (e.g. this fixes commit with hash aaa1111) + b) git commit -a --fixup aaa1111 + c) git rebase --interactive --autosquash aaa1111^ +- Pull request integration tests should generally be passing; +- If you change something non-obvious, please consider adding a ZDTM test for it; + +--> |