From f27a13806c0a7dd505bce8ca6d8651bb4e8cac69 Mon Sep 17 00:00:00 2001 From: Jan Date: Mon, 20 Apr 2020 20:50:11 +0200 Subject: [PATCH] templates for issues and merge_requests for specific user information and better analysis of tradeoffs of certain features --- .gitlab/issue_templates/bug.md | 25 +++++++++++++++++ .gitlab/issue_templates/rfc.md | 27 +++++++++++++++++++ .gitlab/issue_templates/syntax.md | 27 +++++++++++++++++++ .../BREAKING_CHANGE.md | 17 ++++++++++++ .gitlab/merge_request_templates/feat.md | 15 +++++++++++ .gitlab/merge_request_templates/fix.md | 11 ++++++++ 6 files changed, 122 insertions(+) create mode 100644 .gitlab/issue_templates/bug.md create mode 100644 .gitlab/issue_templates/rfc.md create mode 100644 .gitlab/issue_templates/syntax.md create mode 100644 .gitlab/merge_request_templates/BREAKING_CHANGE.md create mode 100644 .gitlab/merge_request_templates/feat.md create mode 100644 .gitlab/merge_request_templates/fix.md diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md new file mode 100644 index 00000000..863f8d59 --- /dev/null +++ b/.gitlab/issue_templates/bug.md @@ -0,0 +1,25 @@ +bug: description + +expect: outcome description + +related: none/#issuenumber + +code: input +``` +shell code +``` + +expect: output +``` +result +``` + +kernel: win10/win7/linux4.4/linux5.7/mac10.0/mac10.15/redox0.3.5/redox0.5.0 + +version: `ion --version`/`git rev-parse HEAD` + +interaction: none/program list + +context: additional setup/run inside terminal multiplexer etc + +behavior of bash/dash/zsh/fish/oil diff --git a/.gitlab/issue_templates/rfc.md b/.gitlab/issue_templates/rfc.md new file mode 100644 index 00000000..8f1629c1 --- /dev/null +++ b/.gitlab/issue_templates/rfc.md @@ -0,0 +1,27 @@ +feat: (description with motivation) + +BREAKING CHANGE: (effect on current programs or datastructures) + +perf: impact + +performance + +usability + +maintainability + +code: input +``` +shell code +``` + +expect: output +``` +result +``` + +reason: (for what use case is this important) + +context: (links, text and further literature) + +behavior of bash/dash/zsh/fish/oil diff --git a/.gitlab/issue_templates/syntax.md b/.gitlab/issue_templates/syntax.md new file mode 100644 index 00000000..7bd127dd --- /dev/null +++ b/.gitlab/issue_templates/syntax.md @@ -0,0 +1,27 @@ +feat: (description with motivation) + +BREAKING CHANGE: (effect on current programs or datastructures?) + +perf: impact + +performance + +usability + +maintainability + +code: input +``` +shell code +``` + +expect: output +``` +result +``` + +reason: (for what use case is this important) + +context: (links, text and further literature) + +behavior of bash/dash/zsh/fish/oil diff --git a/.gitlab/merge_request_templates/BREAKING_CHANGE.md b/.gitlab/merge_request_templates/BREAKING_CHANGE.md new file mode 100644 index 00000000..1289e26a --- /dev/null +++ b/.gitlab/merge_request_templates/BREAKING_CHANGE.md @@ -0,0 +1,17 @@ +feat: description + +closes issue: #RFC + +closes issue: #bug + +BREAKING CHANGE: (where how and what breaks) + +test: unit? + +test: integration in (default in `tests`, otherwise explain concise) + +refactor: affects other tests or data structures? + +docs: documented? + +perf: performance impact? diff --git a/.gitlab/merge_request_templates/feat.md b/.gitlab/merge_request_templates/feat.md new file mode 100644 index 00000000..2c638a42 --- /dev/null +++ b/.gitlab/merge_request_templates/feat.md @@ -0,0 +1,15 @@ +feat: description + +closes issue: #featurediscussion + +test: unit and integration + +unit test? + +integration test in (default in `tests`, otherwise explain concise) + +refactor: affects other tests or data structures? + +docs: documented? + +perf: performance impact? diff --git a/.gitlab/merge_request_templates/fix.md b/.gitlab/merge_request_templates/fix.md new file mode 100644 index 00000000..a5defa8c --- /dev/null +++ b/.gitlab/merge_request_templates/fix.md @@ -0,0 +1,11 @@ +fix: description + +closes issue: #bug + +test: regression tested in (default in `tests`, otherwise explain concise) + +refactor: (affects other tests or data structures?) + +docs: (documented?) + +perf: (performance impact?) -- GitLab