Skip to content

Commit

Permalink
Merge pull request tuxmobil#122 from EventFahrplan/contributing
Browse files Browse the repository at this point in the history
Add guidelines to contribute to the project.
  • Loading branch information
johnjohndoe authored Jan 3, 2019
2 parents d2e2bb2 + dfd7d4c commit b563973
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/CRASH_REPORT_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/BUG_FIX_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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 #
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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 #
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit b563973

Please sign in to comment.