|
| 1 | +# Contributing to NativeScript Push Notifications |
| 2 | + |
| 3 | +:+1: First of all, thank you for taking the time to contribute! :+1: |
| 4 | + |
| 5 | +Here are some guides on how to do that: |
| 6 | + |
| 7 | +<!-- TOC depthFrom:2 --> |
| 8 | + |
| 9 | +- [Code of Conduct](#code-of-conduct) |
| 10 | +- [Reporting Bugs](#reporting-bugs) |
| 11 | +- [Requesting Features](#requesting-features) |
| 12 | +- [Submitting a PR](#submitting-a-pr) |
| 13 | +- [Where to Start](#where-to-start) |
| 14 | + |
| 15 | +<!-- /TOC --> |
| 16 | + |
| 17 | +## Code of Conduct |
| 18 | +Help us keep a healthy and open community. We expect all participants in this project to adhere to the [NativeScript Code Of Conduct](https://github.com/NativeScript/codeofconduct). |
| 19 | + |
| 20 | + |
| 21 | +## Reporting Bugs |
| 22 | + |
| 23 | +1. Always update to the most recent master release; the bug may already be resolved. |
| 24 | +2. Search for similar issues in the issues list for this repo; it may already be an identified problem. |
| 25 | +3. If this is a bug or problem that is clear, simple, and is unlikely to require any discussion -- it is OK to open an issue on GitHub with a reproduction of the bug including workflows and screenshots. If possible, submit a Pull Request with a failing test, entire application or module. If you'd rather take matters into your own hands, fix the bug yourself (jump down to the [Submitting a PR](#submitting-a-pr) section). |
| 26 | + |
| 27 | +## Requesting Features |
| 28 | + |
| 29 | +1. Use Github Issues to submit feature requests. |
| 30 | +2. First, search for a similar request and extend it if applicable. This way it would be easier for the community to track the features. |
| 31 | +3. When requesting a new feature, please provide as much detail as possible about why you need the feature in your apps. We prefer that you explain a need rather than explain a technical solution for it. That might trigger a nice conversation on finding the best and broadest technical solution to a specific need. |
| 32 | + |
| 33 | +## Submitting a PR |
| 34 | + |
| 35 | +Before you begin make sure there is an issue for the bug or feature you will be working on. |
| 36 | + |
| 37 | +Following these steps is the best way to get your code included in the project: |
| 38 | + |
| 39 | +1. Fork and clone the push-plugin repo: |
| 40 | +```bash |
| 41 | +git clone https://github.com/<your-git-username>/push-plugin.git |
| 42 | +# Navigate to the newly cloned directory |
| 43 | +cd push-plugin |
| 44 | +# Add an "upstream" remote pointing to the original repo. |
| 45 | +git remote add upstream https://github.com/NativeScript/push-plugin.git |
| 46 | +``` |
| 47 | + |
| 48 | +2. Read our [development workflow guide](DevelopmentWorkflow.md) for local setup |
| 49 | + |
| 50 | +3. Create a branch for your PR |
| 51 | +```bash |
| 52 | +git checkout -b <my-fix-branch> master |
| 53 | +``` |
| 54 | + |
| 55 | +4. The fun part! Make your code changes. Make sure you: |
| 56 | + - Follow the [code conventions guide](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md). |
| 57 | + - Follow the [commit message guidelines](https://github.com/NativeScript/NativeScript/blob/pr-template/CONTRIBUTING.md#commit-messages) |
| 58 | + - Update the README if you make changes to the plugin API |
| 59 | + |
| 60 | +5. Before you submit your PR: |
| 61 | + - Rebase your changes to the latest master: `git pull --rebase upstream master`. |
| 62 | + - Ensure your changes pass tslint validation. (run `npm run tslint` in the `src` folder). |
| 63 | + |
| 64 | +6. Push your fork. If you have rebased you might have to use force-push your branch: |
| 65 | +``` |
| 66 | +git push origin <my-fix-branch> --force |
| 67 | +``` |
| 68 | + |
| 69 | +7. [Submit your pull request](https://github.com/NativeScript/push-plugin/compare) and compare to `NativeScript/push-plugin`. Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly. |
| 70 | + |
| 71 | +It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks! |
| 72 | + |
| 73 | +## Where to Start |
| 74 | + |
| 75 | +If you want to contribute, but you are not sure where to start - look for issues labeled [`help wanted`](https://github.com/NativeScript/push-plugin/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). |
0 commit comments