Skip to content

Commit 8e15d40

Browse files
committed
Add Issue Template & Contributing Guidelines
• Adds both an issue template and contributing guidelines • Also updates the Readme to be more consistent with the other SDK repos
1 parent d7cafc0 commit 8e15d40

File tree

3 files changed

+84
-5
lines changed

3 files changed

+84
-5
lines changed

CONTRIBUTING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to the OneSignal Android SDK
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
### How to Contribute
6+
We love the open source community and enjoy the support and contributions of many of our users. We ask that any potential contributors to the SDK Follow the following guidelines:
7+
8+
If your proposed contribution is a small bug fix, please feel free to create your own fork of the repository and create a pull request.
9+
10+
If your contribution would _break_ or _change_ the functionality of the SDK, please reach out to us on (contact) before you put in a lot of effort into a change we may not be able to use. We try our best to make sure that the SDK remains stable so that developers do not have to continually change their code, however some breaking changes _are_ desirable, so please get in touch to discuss your idea before you put in a lot of effort.
11+
12+
#### Before Submitting A Bug Report
13+
Before creating bug reports, please check this list of steps to follow.
14+
15+
1. Make sure that you are actually encountering an _issue_ and not a _question_. If you simply have a question about the SDK, we would be more than happy to assist you in our Support section on the web (https://www.onesignal.com - click the Message button at the bottom right)
16+
2. Please make sure to [include as many details as possible](#how-do-i-submit-a-good-bug-report)
17+
18+
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
19+
20+
21+
#### How Do I Submit a Good Bug Report
22+
* **Use a clear and descriptive title** for the issue to identify the problem.
23+
* **Include Reproducibility** It is nearly always a good idea to include steps to reproduce the issue. If you cannot reliably reproduce the issue yourself, that's ok, but reproducible steps help best.
24+
* **Describe your environment**, tell us what version of the Android SDK you are using, how you added it to your project (ie. maven or manually adding it to your project), what version of Android you are targeting, and so on.
25+
* **Include a Stack Trace** If your issue involves a crash/exception, ***PLEASE*** post the stack trace to help us identify the root issue.
26+
* **Include an Example Project** This isn't required, but if you want your issue fixed quickly, it's often a good idea to include an example project as a zip and include it with the issue. You can also download the Demo project (included in the `/Examples` folder of this repo) and set up an example project with this code as a starting point.

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
OneSignal Android Push Notification Plugin
2-
====================================
1+
<p align="center">
2+
<img src="https://onesignal.com/assets/common/logo_onesignal_color.png"/>
3+
</p>
34

4-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.onesignal/OneSignal/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.onesignal/OneSignal)
5-
[![Build Status](https://travis-ci.org/OneSignal/OneSignal-Android-SDK.svg?branch=master)](https://travis-ci.org/OneSignal/OneSignal-Android-SDK)
5+
### OneSignal Android Push Notification Plugin
6+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.onesignal/OneSignal/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.onesignal/OneSignal) [![Build Status](https://travis-ci.org/OneSignal/OneSignal-Android-SDK.svg?branch=master)](https://travis-ci.org/OneSignal/OneSignal-Android-SDK)
67

7-
OneSignal is a free push notification service for mobile apps. This plugin makes it easy to integrate your native Android or Amazon app with OneSignal.
8+
---
9+
10+
[OneSignal](https://onesignal.com/) is a free push notification service for mobile apps. This plugin makes it easy to integrate your native Android or Amazon app with OneSignal.
11+
12+
![alt text](http://www.hesse.io/android2.gif)
813

914
#### Installation
1015
See OneSignal's [Android Native SDK Setup Guide](https://documentation.onesignal.com/docs/android-sdk-setup) for documentation.
@@ -18,3 +23,9 @@ See this repository's [release tags](https://github.com/OneSignal/OneSignal-Andr
1823
#### Support
1924
Please visit this repository's [Github issue tracker](https://github.com/OneSignal/OneSignal-Android-SDK/issues) for feature requests and bug reports related specificly to the SDK.
2025
For account issues and support please contact OneSignal support from the [OneSignal.com](https://onesignal.com) dashboard.
26+
27+
#### Demo Project
28+
To make things easier, we have published demo projects in the `/Examples` folder of this repository.
29+
30+
#### Supports:
31+
* Tested from Android 4.0.3 (API level 15) to Android 8.1 (27)

issue_template.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!--
2+
1. IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION WE MAY CLOSE YOUR ISSUE WITHOUT INVESTIGATION
3+
2. SEARCH EXISTING ISSUES FOR AN ANSWER: https://goo.gl/K3KQNT
4+
3. See our Common Issues documentation: https://goo.gl/DmJAj5
5+
4. See our contributing guidelines: https://goo.gl/fodMiQ
6+
-->
7+
8+
**Description:**
9+
<!-- (write below this line) -->
10+
11+
(your description here)
12+
13+
**Environment**
14+
<!-- Example:
15+
1. What version of the Android SDK are you using?
16+
2. How did you add the SDK to your project (eg. maven)
17+
-->
18+
19+
20+
21+
**Steps to Reproduce Issue:**
22+
<!--
23+
Example:
24+
25+
1. Add the OneSignal SDK to your project
26+
2. Place your App ID in the application's gradle file
27+
3. Attempt to receive a push notification
28+
29+
(write below this line) -->
30+
31+
1. (your steps here)
32+
2.
33+
3.
34+
35+
**Anything else:**
36+
37+
(crash stacktraces, as well as any other information here)
38+
39+
40+
<!--
41+
SEARCH EXISTING ISSUES FOR AN ANSWER: https://goo.gl/K3KQNT
42+
-->

0 commit comments

Comments
 (0)