From b06ef9cf6cc9c7163391471eb8076f5a8cc1825a Mon Sep 17 00:00:00 2001 From: Pedro Pombeiro Date: Wed, 10 Apr 2019 13:15:48 +0200 Subject: [PATCH] Add space for docs PR in PR template Signed-off-by: Pedro Pombeiro --- .github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md | 12 +++++-- .github/ISSUE_TEMPLATE/SIMPLE_ISSUE.md | 8 ++--- .github/PULL_REQUEST_TEMPLATE.md | 32 ++++++++++++------- 3 files changed, 34 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md index 7f3ea7fb0f..2550f3cdd9 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md @@ -18,12 +18,15 @@ As a , I want to so that . *Summary*: ... #### Expected behavior + [comment]: # (Describe what you expected to happen.) #### Actual behavior + [comment]: # (Describe what actually happened.) ### Reproduction + [comment]: # (Describe how we can replicate the bug step by step.) - Open Status @@ -31,21 +34,24 @@ As a , I want to so that . - Step 3, etc. ### Solution + [comment]: # (Please summarise the solution and provide a task list on what needs to be fixed.) -*Summary*: +*Summary*: - [ ] ... - [ ] ... ### Additional Information + [comment]: # (Please do your best to fill this out.) -* Status version: ... +- Status version: ... [comment]: # (Android or iOS.) -* Operating System: +- Operating System: #### Logs [comment]: # (if on Android please replicate bug whilst running adb logcat) + ``` ... ``` diff --git a/.github/ISSUE_TEMPLATE/SIMPLE_ISSUE.md b/.github/ISSUE_TEMPLATE/SIMPLE_ISSUE.md index 8cf3c246a2..fa5afd6469 100644 --- a/.github/ISSUE_TEMPLATE/SIMPLE_ISSUE.md +++ b/.github/ISSUE_TEMPLATE/SIMPLE_ISSUE.md @@ -8,19 +8,19 @@ about: Simple issue report. An overview of the background required to understand the problem. A problem description. -# Implementation +## Implementation Known steps towards feature implementation. What needs further specifying and investigating. -# Acceptance Criteria +## Acceptance Criteria Rules for the future PR to be accepted. -# Notes +## Notes Random notes to keep in mind while implementing it. Mostly about related issues and future plans and thoughts. -# Future Steps +## Future Steps Steps which should be taken after this issue has been resolved. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 718871870e..3b6e661962 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,26 +7,34 @@ If you submit PR for issue with bounty then write here Fixes #NN where NN is iss fixes #... -### Summary: +### Summary [comment]: # (Summarise the problem and how the pull request solves it) ... -### Review notes (optional): - + +Documentation change PR (review please): https://github.com/status-im/status.im/pull/xxx + +### Review notes + + +### Testing notes + + +#### Platforms + -### Testing notes (optional): - -#### Platforms (optional) - Android - iOS - macOS - Linux - Windows - -#### Areas that maybe impacted (optional) -**Functional** +#### Areas that maybe impacted + + +##### Functional + - 1-1 chats - public chats - group chats @@ -40,13 +48,15 @@ fixes #... - fleet - bootnodes -**Non-functional** +##### Non-functional + - battery performance - CPU performance / speed of the app - network consumption +### Steps to test -### Steps to test: + - Open Status - ... - Step 3, etc.