Skip to content

Commit

Permalink
Added Issue Template & Contributing Guidelines
Browse files Browse the repository at this point in the history
• Adds issue template and contributing guidelines to the repo
• Updates the README
  • Loading branch information
Nightsd01 committed Apr 22, 2018
1 parent 8c5bd2e commit 761b16c
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 5 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to the OneSignal Unity SDK

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

### How to Contribute
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:

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.

If your contribution would _break_ or _change_ the functionality of the SDK, please reach out to us 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.

#### Before Submitting A Bug Report
Before creating bug reports, please check this list of steps to follow.

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)
2. Please make sure to [include as many details as possible](#how-do-i-submit-a-good-bug-report)

> **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.

#### How Do I Submit a Good Bug Report
* **Use a clear and descriptive title** for the issue to identify the problem.
* **Include Reproducibility** It is nearly always a good idea to include steps to reproduct the issue. If you cannot reliably reproduce the issue yourself, that's ok, but reproducible steps help best.
* **Describe your environment**, tell us what version of the Unity OneSignal SDK you are using, what platforms the issue occurs on (android/iOS), related code samples, and so on.
* **Include a Stack Trace** If your issue involves a crash/exception, ***PLEASE*** post the stack trace to help us identify the root issue.
* **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 `/OneSignalExample` folder of this repo) and set up an example project with this code as a starting point.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,31 @@
OneSignal Unity Push Notification Plugin
====================================
<p align="center">
<img src="https://onesignal.com/assets/common/logo_onesignal_color.png"/>
</p>

OneSignal is a free push notification service for mobile apps. This plugin makes it easy to integrate your Unity app with OneSignal.
### OneSignal Unity SDK
---

- See https://documentation.onesignal.com/docs/unity-sdk-setup for setup documentation.
- See https://documentation.onesignal.com/docs/unity-sdk for OneSignal API documentation.
[OneSignal](https://onesignal.com/) is a free push notification service for mobile apps. This SDK makes it easy to integrate your Unity app with OneSignal.

![alt text](https://onesignal.com/images/ios_10_notification_image.gif)

#### Installation and Setup
See the [Setup Guide](https://documentation.onesignal.com/docs/unity-sdk-setup) for installation and setup instructions.

#### API
See OneSignal's [Unity SDK API](https://documentation.onesignal.com/docs/unity-sdk) page for a list of all available methods.

#### Change Log
See this repository's [release tags](https://github.com/OneSignal/OneSignal-Unity-SDK/releases) for a complete change log of every released version.

#### Support
Please visit this repository's [Github issue tracker](https://github.com/OneSignal/OneSignal-Unity-SDK/issues) for feature requests and bug reports related specificly to the SDK.

For account issues and support please contact OneSignal support from the [OneSignal.com](https://onesignal.com) dashboard.

#### Demo Project
To make things easier, we have published a demo project in the `OneSignalExample/` folder of this repository.

#### Supports:
* iOS 7 - 11.3
* Android (as well as derivatives such as Amazon ADM)
43 changes: 43 additions & 0 deletions issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!--
1. IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION WE MAY CLOSE YOUR ISSUE WITHOUT INVESTIGATION
2. SEARCH EXISTING ISSUES FOR AN ANSWER: https://goo.gl/CBfk7K
3. See our Common Issues documentation: https://goo.gl/T7siu5
4. See our contributing guidelines: https://goo.gl/uNVgUv
-->

**Description:**
<!-- (write below this line) -->

(your description here)

**Environment**
<!-- Example:
1. What version of the Unity OneSignal SDK are you using?
2. Provide a list of your project dependencies
3. Does the issue occur only in iOS, Android, etc?
-->



**Steps to Reproduce Issue:**
<!--
Example:
1. Import the latest OneSignalSDK.unitypackage into your project
2. Initialize OneSignal with your app ID
3. Attempt to receive a push notification
(write below this line) -->

1. (your steps here)
2.
3.

**Anything else:**

(crash stacktraces, as well as any other information here)


<!--
SEARCH EXISTING ISSUES FOR AN ANSWER: https://goo.gl/CBfk7K
-->

0 comments on commit 761b16c

Please sign in to comment.