From 48d7df5e5676db530f6a2e2d9fee9270c2186ad0 Mon Sep 17 00:00:00 2001 From: meliurwen Date: Tue, 22 Mar 2022 12:05:47 +0100 Subject: [PATCH] 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.