From fed9d524c412e1363b0734e412ba5bb4f11e06ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piet=20G=C3=B6mpel?= <37657534+Pietfried@users.noreply.github.com> Date: Thu, 1 Feb 2024 17:05:47 +0100 Subject: [PATCH 1/8] * Added issue and PR templates * Added CODEOWNERS file * Added links to CONTRIBUTION.md and COMMUNITY.md to README.md Signed-off-by: pietfried --- .github/CODEOWNERS | 2 ++ .github/ISSUE_TEMPLATE/bug_report.yaml | 36 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 39 +++++++++++++++++++++ .github/pull_request_template.md | 9 +++++ README.md | 4 +++ 5 files changed, 90 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/pull_request_template.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..4f7c76d54 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +* @pietfried @hikinggrass @marcemmers @maaikez +/.github/ @pietfried diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..8478647c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,36 @@ +name: Bug Report +description: Thanks for taking the time to fill out this bug report! + +body: + - type: dropdown + id: affected-ocpp-version + attributes: + label: OCPP Version + description: Which OCPP is affected? Mark both if applicable. + options: + - OCPP1.6 + - OCPP2.0.1 + multiple: true + validations: + required: true + + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If applicable, add screenshots or logfiles to help explain your problem. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: To Reproduce + description: | + If applicable describe the steps to and additional information to reproduce the behavior like message communication between CSMS, used configuration(s) and your system information + + - type: textarea + id: other + attributes: + label: Anything else? + placeholder: Add any other context about the bug report here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..58f9c05cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,39 @@ +name: Feature Request +description: Thanks for taking the time to fill out this feature request! + +body: + - type: dropdown + id: affected-ocpp-version + attributes: + label: OCPP Version + description: For which OCPP do you suggest this feature? Mark both if applicable. + options: + - OCPP1.6 + - OCPP2.0.1 + multiple: true + validations: + required: true + + - type: textarea + id: description + attributes: + label: Describe the problem + description: Is your feature request related to a problem? Please describe. + placeholder: | + A clear and concise description of what the problem is. + + - type: textarea + id: reproduction + attributes: + label: Describe your solution + description: Describe the solution you'd like + placeholder: | + A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: other + attributes: + label: Additional context + placeholder: Add any other context about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..5687f577e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ +## Describe your changes + +## Issue ticket number and link + +## Checklist before requesting a review +- [ ] I have performed a self-review of my code +- [ ] My code follows the style guidelines of this project +- [ ] I have made corresponding changes to the documentation + diff --git a/README.md b/README.md index 7a8e83412..26c190209 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ Libocpp can be used for the communication of one charging station and multiple E Libocpp provides a complete implementation of OCPP 1.6. The implementation of OCPP 2.0.1 is currently under development. +## Get Involved + +See the [COMMUNITY.md](COMMUNITY.md) and [COMMUNITY.md](COMMUNITY.md) of the EVerest project to get involved. + ## Table of contents - [C++ implementation of OCPP](#c-implementation-of-ocpp) - [Table of contents](#table-of-contents) From 66ce53b6ec78a655b78d95a35ee020c0fda08f55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piet=20G=C3=B6mpel?= <37657534+Pietfried@users.noreply.github.com> Date: Mon, 5 Feb 2024 11:58:44 +0100 Subject: [PATCH 2/8] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Philip Molares Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com> --- .github/pull_request_template.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5687f577e..037499bf7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,4 +6,7 @@ - [ ] I have performed a self-review of my code - [ ] My code follows the style guidelines of this project - [ ] I have made corresponding changes to the documentation +- [ ] I read the [contribution documentation](https://github.com/EVerest/libocpp/blob/main/CONTRIBUTING.md) and + made sure that: + - My commits are signed-off to accept the DCO. From 2acc7f9a757ca36a390e89aaf7c6c40992eafd0d Mon Sep 17 00:00:00 2001 From: pietfried Date: Mon, 5 Feb 2024 12:07:18 +0100 Subject: [PATCH 3/8] * Fixed links in README.md * added compile options in description for bug reproduction * Feature request: changed requirement of problem description to mandatory and solution to optional Signed-off-by: pietfried --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 6 +++--- README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 8478647c6..a268301e2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -27,7 +27,7 @@ body: attributes: label: To Reproduce description: | - If applicable describe the steps to and additional information to reproduce the behavior like message communication between CSMS, used configuration(s) and your system information + If applicable describe the steps to and additional information to reproduce the behavior like message communication between CSMS, used configuration(s), compile options and your system information - type: textarea id: other diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 58f9c05cc..47fcfac95 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -18,9 +18,11 @@ body: id: description attributes: label: Describe the problem - description: Is your feature request related to a problem? Please describe. + description: What problem is your feature request targeting and why is it a problem? Please describe. placeholder: | A clear and concise description of what the problem is. + validations: + required: true - type: textarea id: reproduction @@ -29,8 +31,6 @@ body: description: Describe the solution you'd like placeholder: | A clear and concise description of what you want to happen. - validations: - required: true - type: textarea id: other diff --git a/README.md b/README.md index 26c190209..190d529eb 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Libocpp provides a complete implementation of OCPP 1.6. The implementation of OC ## Get Involved -See the [COMMUNITY.md](COMMUNITY.md) and [COMMUNITY.md](COMMUNITY.md) of the EVerest project to get involved. +See the [COMMUNITY.md](https://github.com/EVerest/EVerest/blob/main/COMMUNITY.md) and [CONTRIBUTING.md](https://github.com/EVerest/EVerest/blob/main/CONTRIBUTING.md) of the EVerest project to get involved. ## Table of contents - [C++ implementation of OCPP](#c-implementation-of-ocpp) From aa5c7b606c4ad12b86ffbbeca8daaf2153dc33df Mon Sep 17 00:00:00 2001 From: pietfried Date: Mon, 5 Feb 2024 12:09:51 +0100 Subject: [PATCH 4/8] updated PR template Signed-off-by: pietfried --- .github/pull_request_template.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 037499bf7..45373f892 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,5 @@ - [ ] I have performed a self-review of my code - [ ] My code follows the style guidelines of this project - [ ] I have made corresponding changes to the documentation -- [ ] I read the [contribution documentation](https://github.com/EVerest/libocpp/blob/main/CONTRIBUTING.md) and - made sure that: - - My commits are signed-off to accept the DCO. +- [ ] I read the [contribution documentation](https://github.com/EVerest/libocpp/blob/main/CONTRIBUTING.md) and made sure that my changes meet its requirements From eecb2e4775a7f2f3a7347e32be5f2e80e874a5ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piet=20G=C3=B6mpel?= <37657534+Pietfried@users.noreply.github.com> Date: Wed, 14 Feb 2024 12:04:59 +0100 Subject: [PATCH 5/8] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com> --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 45373f892..935a4ed5b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,5 +6,5 @@ - [ ] I have performed a self-review of my code - [ ] My code follows the style guidelines of this project - [ ] I have made corresponding changes to the documentation -- [ ] I read the [contribution documentation](https://github.com/EVerest/libocpp/blob/main/CONTRIBUTING.md) and made sure that my changes meet its requirements +- [ ] I read the [contribution documentation](https://github.com/EVerest/EVerest/blob/main/CONTRIBUTING.md) and made sure that my changes meet its requirements From 1033af1d764f50fb513effe5743389151217e308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piet=20G=C3=B6mpel?= <37657534+Pietfried@users.noreply.github.com> Date: Wed, 14 Feb 2024 12:05:48 +0100 Subject: [PATCH 6/8] Update .github/pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com> --- .github/pull_request_template.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 935a4ed5b..e4b7d8be6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,6 @@ ## Checklist before requesting a review - [ ] I have performed a self-review of my code -- [ ] My code follows the style guidelines of this project - [ ] I have made corresponding changes to the documentation - [ ] I read the [contribution documentation](https://github.com/EVerest/EVerest/blob/main/CONTRIBUTING.md) and made sure that my changes meet its requirements From 0f36ed0e0d1cc0c9bfbb2ab4517f330698250007 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piet=20G=C3=B6mpel?= <37657534+Pietfried@users.noreply.github.com> Date: Wed, 14 Feb 2024 12:06:33 +0100 Subject: [PATCH 7/8] Update .github/CODEOWNERS MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com> --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4f7c76d54..4653fe65a 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,2 @@ * @pietfried @hikinggrass @marcemmers @maaikez -/.github/ @pietfried +/.github/ @pietfried @hikinggrass From 8b7f98f1eff5692be2febc28c11cd37ce0befe8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piet=20G=C3=B6mpel?= <37657534+Pietfried@users.noreply.github.com> Date: Wed, 14 Feb 2024 12:08:47 +0100 Subject: [PATCH 8/8] Update .github/ISSUE_TEMPLATE/feature_request.yaml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 47fcfac95..962f9c55d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -25,7 +25,7 @@ body: required: true - type: textarea - id: reproduction + id: solution attributes: label: Describe your solution description: Describe the solution you'd like