Merge branch 'meta-templates' into 'dev'

pull/30/head
Meliurwen 3 years ago
commit 4217654c3a
Signed by: meliurwen
GPG Key ID: 818A8B35E9F1CE10
  1. 40
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 26
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 37
      .github/PULL_REQUEST_TEMPLATE/merge_master.md
  4. 23
      .github/pull_request_template.md
  5. 8
      CONTRIBUTING.md

@ -0,0 +1,40 @@
---
name: 🐞 Bug report
about: Create a bug report to help us improve this project
title: '[Bug] '
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

@ -0,0 +1,26 @@
---
name: 🛠 Feature request
about: Suggest an idea for this project
title: '[Feature] '
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

@ -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.

@ -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

@ -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.

Loading…
Cancel
Save