From f36c1bd82df486c0f930b45644dc21bf89229b44 Mon Sep 17 00:00:00 2001 From: meliurwen Date: Tue, 22 Mar 2022 10:59:50 +0100 Subject: [PATCH 1/4] Added bug and feature templates for the issues --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 +++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e5c66f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: 🐞 Bug report +about: Create a bug report to help us improve this project +title: '' +labels: 'bug' +assignees: '' + +--- + +## Basic info + +* **Library Version:** +* **Branch/commit:** +* **OS:** +* **Rust Version:** +* **Other:** + +## Expected Behavior + +The library does X + +## Actual Behavior + +The library does Y + +## Steps to Reproduce + +* Do X +* Do Y +* Do Z + +## Log tracebacks and/or errors shown + +```txt +Log here +``` + +## (Optional) Extra info + +None diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..77b8e2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: 🛠️ Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' + +--- + +## Description + +As a X, I want to Y, so Z. + +## Acceptance Criteria + +* Criteria 1 +* Criteria 2 + +## Checklist + +* [ ] Element 1 +* [ ] Element 2 + +## (Optional) Extra info + +None From 4ae7fe6bcd81debd4edce7f8b0105bd8143f41e6 Mon Sep 17 00:00:00 2001 From: meliurwen Date: Tue, 22 Mar 2022 11:02:51 +0100 Subject: [PATCH 2/4] Added small tweaks to the issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e5c66f9..0756672 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: 🐞 Bug report about: Create a bug report to help us improve this project -title: '' +title: '[Bug] ' labels: 'bug' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 77b8e2e..c65563c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: 🛠️ Feature request about: Suggest an idea for this project -title: '' +title: '[Feature] ' labels: 'enhancement' assignees: '' From bc599cb9fe6e4db0e2ab377e584b4bb131576b81 Mon Sep 17 00:00:00 2001 From: meliurwen Date: Tue, 22 Mar 2022 11:37:16 +0100 Subject: [PATCH 3/4] Added templates for Pull Requests into master and dev --- .github/ISSUE_TEMPLATE/feature_request.md | 4 +- .github/PULL_REQUEST_TEMPLATE/merge_master.md | 37 +++++++++++++++++++ .github/pull_request_template.md | 23 ++++++++++++ 3 files changed, 62 insertions(+), 2 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/merge_master.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c65563c..3be2444 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -18,8 +18,8 @@ As a X, I want to Y, so Z. ## Checklist -* [ ] Element 1 -* [ ] Element 2 +* [ ] Element 1 +* [ ] Element 2 ## (Optional) Extra info diff --git a/.github/PULL_REQUEST_TEMPLATE/merge_master.md b/.github/PULL_REQUEST_TEMPLATE/merge_master.md new file mode 100644 index 0000000..657afc6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/merge_master.md @@ -0,0 +1,37 @@ +# Pull/Merge Request into master + +## Version + +* **From:** `x.x.x` +* **To:** `y.y.y` +* **Type:** `major|minor|bugfix` +* **Changelog:** [here](CHANGELOG.md) + +## Merge into Dev Checklist + +* [ ] Code review +* [ ] Tests for the new code (coverage >80%) +* [ ] Pipeline pass +* [ ] No errors on coding standards +* [ ] This is a merge from develop +* [ ] Deployed to staging environment +* [ ] Acceptance Testing pass +* [ ] Bump version in [Cargo.toml](Cargo.toml) file +* [ ] Updated [CHANGELOG.md](CHANGELOG.md) file + +## Issues related + +* #123456 +* #123457 + +## Merge Requests related + +* !123456 +* !123457 + +## Description + +Description here + +To know more read the [CHANGELOG.md](CHANGELOG.md) file, the issues and the +merge requests related. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7e51286 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +# Pull/Merge Request into master dev + +## Description + +See the issue related, what is done in the commits and in the changelog below. + +## Issues related + +* #123456 + +## Merge into Dev Checklist + +* [ ] Tests for the new code +* [ ] Acceptance Testing + +## Changelog + +* Change 1 +* Change 2 + +## (Optional) Extra info + +None From 48d7df5e5676db530f6a2e2d9fee9270c2186ad0 Mon Sep 17 00:00:00 2001 From: meliurwen Date: Tue, 22 Mar 2022 12:05:47 +0100 Subject: [PATCH 4/4] Added notes regarding templates in CONRIBUTING.md --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b6b75c9..59049bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,7 @@ appreciated! consider the following when opening an issue: + Avoid opening duplicate issues by taking a look at the current open issues. ++ Follow [this template](.github/ISSUE_TEMPLATE/bug_report.md). + Provide details on the library version, operating system and Rust version you are running. + Provide the **expected** and the **actual** behavior. @@ -26,6 +27,7 @@ consider the following when opening an issue: + Avoid opening duplicate issues by taking a look at the current open and closed ones. ++ Follow [this template](.github/ISSUE_TEMPLATE/feature_request.md). + The feature must be concrete enough to visualize, broken into parts, easy to manage and the task not too heavy. + Provide a short description from the point of view the actor(s) who will @@ -43,7 +45,8 @@ consider the following when opening an issue: All pull requests are welcome, but please consider the following: -+ **You cannot merge into master**. ++ **You cannot merge into master**, merge in **dev** instead. ++ Follow [this template](.github/pull_request_template.md). + Please open an issue first if a relevant one is not already open. + Include tests. + Include documentation for new features. @@ -61,3 +64,6 @@ All pull requests are welcome, but please consider the following: > + In case an **hotfix** is necessary you can only _branch from master_, apply > the fix (maybe cherry-picking from other branches) and then merge back to > master. +> + For contributors who have write permissions to master +> [here the template](.github/PULL_REQUEST_TEMPLATE/merge_master.md) for the +> merge request.