Add space for docs PR in PR template
Signed-off-by: Pedro Pombeiro <pombeirp@users.noreply.github.com>
This commit is contained in:
parent
14f3b43090
commit
b06ef9cf6c
|
@ -18,12 +18,15 @@ As a <user|developer|...>, I want to <task> so that <goal>.
|
||||||
*Summary*: ...
|
*Summary*: ...
|
||||||
|
|
||||||
#### Expected behavior
|
#### Expected behavior
|
||||||
|
|
||||||
[comment]: # (Describe what you expected to happen.)
|
[comment]: # (Describe what you expected to happen.)
|
||||||
|
|
||||||
#### Actual behavior
|
#### Actual behavior
|
||||||
|
|
||||||
[comment]: # (Describe what actually happened.)
|
[comment]: # (Describe what actually happened.)
|
||||||
|
|
||||||
### Reproduction
|
### Reproduction
|
||||||
|
|
||||||
[comment]: # (Describe how we can replicate the bug step by step.)
|
[comment]: # (Describe how we can replicate the bug step by step.)
|
||||||
|
|
||||||
- Open Status
|
- Open Status
|
||||||
|
@ -31,6 +34,7 @@ As a <user|developer|...>, I want to <task> so that <goal>.
|
||||||
- Step 3, etc.
|
- Step 3, etc.
|
||||||
|
|
||||||
### Solution
|
### Solution
|
||||||
|
|
||||||
[comment]: # (Please summarise the solution and provide a task list on what needs to be fixed.)
|
[comment]: # (Please summarise the solution and provide a task list on what needs to be fixed.)
|
||||||
*Summary*:
|
*Summary*:
|
||||||
|
|
||||||
|
@ -38,14 +42,16 @@ As a <user|developer|...>, I want to <task> so that <goal>.
|
||||||
- [ ] ...
|
- [ ] ...
|
||||||
|
|
||||||
### Additional Information
|
### Additional Information
|
||||||
|
|
||||||
[comment]: # (Please do your best to fill this out.)
|
[comment]: # (Please do your best to fill this out.)
|
||||||
* Status version: ...
|
- Status version: ...
|
||||||
[comment]: # (Android or iOS.)
|
[comment]: # (Android or iOS.)
|
||||||
* Operating System: <Android|iOS>
|
- Operating System: <Android|iOS>
|
||||||
|
|
||||||
#### Logs
|
#### Logs
|
||||||
|
|
||||||
[comment]: # (if on Android please replicate bug whilst running adb logcat)
|
[comment]: # (if on Android please replicate bug whilst running adb logcat)
|
||||||
|
|
||||||
```
|
```
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
|
@ -8,19 +8,19 @@ about: Simple issue report.
|
||||||
An overview of the background required to understand the problem.
|
An overview of the background required to understand the problem.
|
||||||
A problem description.
|
A problem description.
|
||||||
|
|
||||||
# Implementation
|
## Implementation
|
||||||
|
|
||||||
Known steps towards feature implementation.
|
Known steps towards feature implementation.
|
||||||
What needs further specifying and investigating.
|
What needs further specifying and investigating.
|
||||||
|
|
||||||
# Acceptance Criteria
|
## Acceptance Criteria
|
||||||
|
|
||||||
Rules for the future PR to be accepted.
|
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.
|
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.
|
Steps which should be taken after this issue has been resolved.
|
||||||
|
|
|
@ -7,26 +7,34 @@ If you submit PR for issue with bounty then write here Fixes #NN where NN is iss
|
||||||
|
|
||||||
fixes #...
|
fixes #...
|
||||||
|
|
||||||
### Summary:
|
### Summary
|
||||||
|
|
||||||
[comment]: # (Summarise the problem and how the pull request solves it)
|
[comment]: # (Summarise the problem and how the pull request solves it)
|
||||||
...
|
...
|
||||||
|
|
||||||
### Review notes (optional):
|
<!-- (Optional, remove if no changes to documentation) -->
|
||||||
<!-- (Specify if something in particular should be looked at, or ignored, during review) -->
|
Documentation change PR (review please): https://github.com/status-im/status.im/pull/xxx
|
||||||
|
|
||||||
|
### Review notes
|
||||||
|
<!-- (Optional. Specify if something in particular should be looked at, or ignored, during review) -->
|
||||||
|
|
||||||
|
### Testing notes
|
||||||
|
<!-- (Optional) -->
|
||||||
|
|
||||||
|
#### Platforms
|
||||||
|
<!-- (Optional. Specify which platforms should be tested) -->
|
||||||
|
|
||||||
### Testing notes (optional):
|
|
||||||
<!-- (Specify which platforms should be tested) -->
|
|
||||||
#### Platforms (optional)
|
|
||||||
- Android
|
- Android
|
||||||
- iOS
|
- iOS
|
||||||
- macOS
|
- macOS
|
||||||
- Linux
|
- Linux
|
||||||
- Windows
|
- Windows
|
||||||
|
|
||||||
<!-- (Specify if some specific areas has to be tested, for example 1-1 chats) -->
|
#### Areas that maybe impacted
|
||||||
#### Areas that maybe impacted (optional)
|
<!-- (Optional. Specify if some specific areas has to be tested, for example 1-1 chats) -->
|
||||||
**Functional**
|
|
||||||
|
##### Functional
|
||||||
|
|
||||||
- 1-1 chats
|
- 1-1 chats
|
||||||
- public chats
|
- public chats
|
||||||
- group chats
|
- group chats
|
||||||
|
@ -40,13 +48,15 @@ fixes #...
|
||||||
- fleet
|
- fleet
|
||||||
- bootnodes
|
- bootnodes
|
||||||
|
|
||||||
**Non-functional**
|
##### Non-functional
|
||||||
|
|
||||||
- battery performance
|
- battery performance
|
||||||
- CPU performance / speed of the app
|
- CPU performance / speed of the app
|
||||||
- network consumption
|
- network consumption
|
||||||
|
|
||||||
|
### Steps to test
|
||||||
<!-- (Specify exact steps to test if there are such) -->
|
<!-- (Specify exact steps to test if there are such) -->
|
||||||
### Steps to test:
|
|
||||||
- Open Status
|
- Open Status
|
||||||
- ...
|
- ...
|
||||||
- Step 3, etc.
|
- Step 3, etc.
|
||||||
|
|
Loading…
Reference in New Issue