From 99c556b42c58600ad38e611f80a5fcfe93eeb195 Mon Sep 17 00:00:00 2001 From: Jarrad Hope Date: Sun, 12 Feb 2017 12:40:57 +0700 Subject: [PATCH] github templates --- .github/CONTRIBUTING.md | 17 ++++++++++++ .github/ISSUE_TEMPLATE.md | 46 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++ 3 files changed, 79 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..32f9fb581f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..ce3ccf0f0b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,46 @@ +[comment]: # (Please replace ... with your information. Remove < and >) + +### User Story + +As a , I want to so that . + +### Description + +[comment]: # (Feature or Bug? i.e Type: Bug) +*Type*: + +[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: + +#### Logs + +[comment]: # (if on Android please replicate bug whilst running adb logcat) +``` +... +``` \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..4dfa4916d5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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: +