commit
0951618ad8
|
@ -0,0 +1,17 @@
|
||||||
|
# Contributing to Status
|
||||||
|
|
||||||
|
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
||||||
|
|
||||||
|
The following is a set of guidelines for contributing to Status and its packages, which are hosted in the [Status Organisation](https://github.com/status-im) on GitHub.
|
||||||
|
|
||||||
|
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||||||
|
|
||||||
|
#### What should I know before I get started?
|
||||||
|
|
||||||
|
* [Mission and Core Values](http://wiki.status.im/getting-started/mission-and-core-values/)
|
||||||
|
* [Code of Conduct](http://wiki.status.im/getting-started/code-of-conduct/)
|
||||||
|
* [Read our FAQ](http://wiki.status.im/getting-started/faq/)
|
||||||
|
* [Join our Slack](http://slack.status.im/) and chat in `#dev-status`
|
||||||
|
* [Developer Introduction](http://wiki.status.im/contributing/development/introduction/)
|
||||||
|
* [How to Build Status](http://wiki.status.im/contributing/development/building-status/)
|
||||||
|
* [Finding issues to work on](http://wiki.status.im/contributing/development/introduction/#finding-issues-to-work-on)
|
|
@ -0,0 +1,46 @@
|
||||||
|
[comment]: # (Please replace ... with your information. Remove < and >)
|
||||||
|
|
||||||
|
### User Story
|
||||||
|
|
||||||
|
As a <user|developer|...>, I want to <task> so that <goal>.
|
||||||
|
|
||||||
|
### Description
|
||||||
|
|
||||||
|
[comment]: # (Feature or Bug? i.e Type: Bug)
|
||||||
|
*Type*: <Bug|Feature>
|
||||||
|
|
||||||
|
[comment]: # (Describe the feature you would like, or briefly summarise the bug and what you did, what you expected to happen, and what actually happens. Sections below)
|
||||||
|
*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
|
||||||
|
- ...
|
||||||
|
- Step 3, etc.
|
||||||
|
|
||||||
|
### Solution
|
||||||
|
[comment]: # (Please summarise the solution and provide a task list on what needs to be fixed.)
|
||||||
|
*Summary*:
|
||||||
|
|
||||||
|
- [ ] ...
|
||||||
|
- [ ] ...
|
||||||
|
|
||||||
|
### Additional Information
|
||||||
|
[comment]: # (Please do your best to fill this out.)
|
||||||
|
* Status version: ...
|
||||||
|
[comment]: # (Android or iOS.)
|
||||||
|
* Operating System: <Android|iOS>
|
||||||
|
|
||||||
|
#### Logs
|
||||||
|
|
||||||
|
[comment]: # (if on Android please replicate bug whilst running adb logcat)
|
||||||
|
```
|
||||||
|
...
|
||||||
|
```
|
|
@ -0,0 +1,16 @@
|
||||||
|
[comment]: # (Please replace ... with your information. Remove < and >)
|
||||||
|
[comment]: # (To auto-close issue on merge, please insert the related issue number after # i.e fixes #566)
|
||||||
|
fixes #...
|
||||||
|
|
||||||
|
### Summary:
|
||||||
|
[comment]: # (Summarise the problem and how the pull request solves it)
|
||||||
|
...
|
||||||
|
|
||||||
|
### Steps to test:
|
||||||
|
- Open Status
|
||||||
|
- ...
|
||||||
|
- Step 3, etc.
|
||||||
|
|
||||||
|
[comment]: # (PRs will only be accepted if squashed into single commit.)
|
||||||
|
status: <ready|wip>
|
||||||
|
|
Loading…
Reference in New Issue