From b1cfc18262c0fb719379b336f604cc8cbebce18e Mon Sep 17 00:00:00 2001 From: Tobias Preuss Date: Thu, 3 Jan 2019 23:05:48 +0100 Subject: [PATCH 1/2] Extend the contributing guide. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcf0d4098..d5040c710 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,10 @@ In order to simplify the process please try to follow the following suggestions: * Make sure each commit compiles. * Rebase your branch onto the latest commit on `master`. * Do not merge `master` into your branch. The project maintainer will merge your branch into `master` instead. +* Describe the intention of your pull request. Screenshots help others to understand the before and after state. * Feel free to reorganize the commits on your branch by using `git rebase --interactive` or `git push --force`. * Make sure to apply [automatic code formatting and organize imports][code-formatting] as it is provided by Android Studio. +* Write unit tests. [code-formatting]: http://stackoverflow.com/a/5581992/356895 From dfd7d4cad53bca15660967832118ba2aaa7d4aaf Mon Sep 17 00:00:00 2001 From: Tobias Preuss Date: Thu, 3 Jan 2019 23:06:15 +0100 Subject: [PATCH 2/2] Add GitHub templates for issues and pull requests. --- .github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md | 26 +++++++++++++++++ .../ISSUE_TEMPLATE/CRASH_REPORT_TEMPLATE.md | 28 +++++++++++++++++++ .../PULL_REQUEST_TEMPLATE/BUG_FIX_TEMPLATE.md | 24 ++++++++++++++++ .../FEATURE_REQUEST_TEMPLATE.md | 23 +++++++++++++++ 4 files changed, 101 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/CRASH_REPORT_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/BUG_FIX_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md new file mode 100644 index 000000000..2ea3b7184 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Create a report to help to improve the project + +--- + +# Environment +- App version: +- Android version: +- Branch: +- Device: + +# How to reproduce +1. Ordered list of steps +2. to reproduce +3. the issue + +# Observed behavior +- What happened? +- Add screenshot(s). + +# Expected behavior +- What should happen? + +# Related +- Link to related issues here if applicable. diff --git a/.github/ISSUE_TEMPLATE/CRASH_REPORT_TEMPLATE.md b/.github/ISSUE_TEMPLATE/CRASH_REPORT_TEMPLATE.md new file mode 100644 index 000000000..59d92cb13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/CRASH_REPORT_TEMPLATE.md @@ -0,0 +1,28 @@ +--- +name: Crash report +about: A crash sent by mail or extracted from Google Play + +--- + +Crash report from a user: + +- Sent: dd.mm.yyyy +- App version: +- Android version: +- Device model: + +# Stacktrace +``` java +Paste stacktrace here. +``` + +# Log +``` java +Paste log output here. +``` + +# User report +- Paste what the users wrote to provide context. + +# Related +- Link to related issues here if applicable. diff --git a/.github/PULL_REQUEST_TEMPLATE/BUG_FIX_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/BUG_FIX_TEMPLATE.md new file mode 100644 index 000000000..fc18b0799 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/BUG_FIX_TEMPLATE.md @@ -0,0 +1,24 @@ +--- +name: Bug fix +about: Resolve a bug in the project + +--- + +# Description +- Short summary of the bug you fixed. +- Link to the associated issue if applicable. +- Link to an external bug tracker if applicable. +- Which device/emulator and Android version did you test on? + +# Before +- Describe the behavior before the bug fix. +- Add screenshot(s). + +# After +- Describe the behavior after the bug fix. +- Add screenshot(s). + +# Contributing guidelines +- Make sure to read the [contributing guidelines](../../CONTRIBUTING.md) *before* creating this pull request. + +Resolves # diff --git a/.github/PULL_REQUEST_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..29211cca4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Add your idea to the project + +--- + +# Description +- Short summary of what you are trying to accomplish. +- Link to the associated issue if applicable. +- Which device/emulator and Android version did you test on? + +# Before +- Describe the behavior before the change. +- Add screenshot(s). + +# After +- Describe the behavior after the change. +- Add screenshot(s). + +# Contributing guidelines +- Make sure to read the [contributing guidelines](../../CONTRIBUTING.md) *before* creating this pull request. + +Resolves #