diff options
| author | fxedel <fxedel@gmail.com> | 2016-04-05 23:38:34 +0300 |
|---|---|---|
| committer | Niedermann IT-Dienstleistungen <stefan-niedermann@users.noreply.github.com> | 2016-04-05 23:38:34 +0300 |
| commit | 8395c424adc7feb1ccdf8bccbe4df833c57276c5 (patch) | |
| tree | afe8b5ee142c3de3166e6d6db0b8529f58e36419 /CONTRIBUTING.md | |
| parent | 0d02b7cd077b8ede10ad01df8a0a0a2d0bb86f6c (diff) | |
Contribution.md updated
- add android version, bold text and copy&paste source code
- add "new feature" section, improved bug reporting
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 39 |
1 files changed, 34 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdf00e75..8b3ec9e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,42 @@ -# Bug Report +# Contributing guide -Source: Google Play Store, F-Droid or self-built? +## Submitting bug reports -Version: vx.x.x (e. g. v0.5.1) +If you find a bug, feel free to [open an issue](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/new). But please provide these information in the comment: -Device: e. g. Motorola Moto G 2015 +**Android version:** e. g. 6.0.1 Marshmallow -Steps to reproduce: +**Device**: e. g. Motorola Moto G 2015 + +**System language**: English (US), German, ... + +**App version:** e. g. v0.8.1 + +**App source:** Google Play Store, F-Droid or self-built? + +**Steps to reproduce:** 1. open the app 2. click on a note 3. use the top left back-arrow 4. ... + +### Copy & Paste + **Android version:** e. g. 6.0.1 Marshmallow + + **Device**: e. g. Motorola Moto G 2015 + + **System language**: English (US), German, ... + + **App version:** e. g. v0.8.1 + + **App source:** Google Play Store, F-Droid or self-built? + + **Steps to reproduce:** + 1. open the app + 2. click on a note + 3. use the top left back-arrow + 4. ... + +## Adding new features + +If you want to contribute on the code, you can fork the project, commit your changes and make a pull request. For bigger features/changes, it's better to first [open an issue](https://github.com/stefan-niedermann/OwnCloud-Notes/issues/new) and ask if this feature is needed or wanted – it would be very disappointing if you add a new cool feature and your pull request will be rejected by some reasons you didn't thought about. |