diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..d103b9f --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,28 @@ +### Make sure to check the demo app(s) for sample usage + +### Make sure to check the existing issues in this repository + +### If the demo apps cannot help and there is no issue for your problem, tell us about it +Please, ensure your title is less than 63 characters long and starts with a capital +letter. + +### Which platform(s) does your issue occur on? +- iOS/Android/Both +- iOS/Android versions +- emulator or device. What type of device? + +### Please, provide the following version numbers that your issue occurs with: + +- CLI: (run `tns --version` to fetch it) +- Cross-platform modules: (check the 'version' attribute in the +`node_modules/tns-core-modules/package.json` file in your project) +- Runtime(s): (look for the `"tns-android"` and `"tns-ios"` properties in the `package.json` file of your project) +- Plugin(s): (look for the version numbers in the `package.json` file of your +project and paste your dependencies and devDependencies here) + +### Please, tell us how to recreate the issue in as much detail as possible. +Describe the steps to reproduce it. + +### Is there any code involved? + - provide a code example to recreate the problem + - (EVEN BETTER) provide a .zip with application or refer to a repository with application where the problem is reproducible. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e1becd3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ + + + + + +## PR Checklist + +- [ ] The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages. +- [ ] There is an issue for the bug/feature this PR is for. To avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it. +- [ ] All existing tests are passing +- [ ] Tests for the changes are included + +## What is the current behavior? + + +## What is the new behavior? + + +Fixes/Implements/Closes #[Issue Number]. + + + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3ba6b65 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,75 @@ +# Contributing to NativeScript Background HTTP + +:+1: First of all, thank you for taking the time to contribute! :+1: + +Here are some guides on how to do that: + + + +- [Code of Conduct](#code-of-conduct) +- [Reporting Bugs](#reporting-bugs) +- [Requesting Features](#requesting-features) +- [Submitting a PR](#submitting-a-pr) +- [Where to Start](#where-to-start) + + + +## Code of Conduct +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). + + +## Reporting Bugs + +1. Always update to the most recent master release; the bug may already be resolved. +2. Search for similar issues in the issues list for this repo; it may already be an identified problem. +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). + +## Requesting Features + +1. Use Github Issues to submit feature requests. +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. +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. + +## Submitting a PR + +Before you begin make sure there is an issue for the bug or feature you will be working on. + +Following these steps is the best way to get your code included in the project: + +1. Fork and clone the nativescript-background-http repo: +```bash +git clone https://github.com/NativeScript/nativescript-background-http.git +# Navigate to the newly cloned directory +cd nativescript-background-http +# Add an "upstream" remote pointing to the original repo. +git remote add upstream https://github.com/NativeScript/nativescript-background-http.git +``` + +2. Read our [development workflow guide](DevelopmentWorkflow.md) for local setup + +3. Create a branch for your PR +```bash +git checkout -b master +``` + +4. The fun part! Make your code changes. Make sure you: + - Follow the [code conventions guide](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md). + - Follow the [commit message guidelines](https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages) + - Update the README if you make changes to the plugin API + +5. Before you submit your PR: + - Rebase your changes to the latest master: `git pull --rebase upstream master`. + - Ensure your changes pass tslint validation. (run `npm run tslint` in the `src` folder). + +6. Push your fork. If you have rebased you might have to use force-push your branch: +``` +git push origin --force +``` + +7. [Submit your pull request](https://github.com/NativeScript/nativescript-background-http/compare) and compare to `NativeScript/nativescript-background-http`. Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly. + +It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks! + +## Where to Start + +If you want to contribute, but you are not sure where to start - look for issues labeled [`help wanted`](https://github.com/NativeScript/nativescript-background-http/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). diff --git a/README.md b/README.md index b57ad0c..c9eda23 100644 --- a/README.md +++ b/README.md @@ -84,3 +84,12 @@ var params = [ ]; task = session.multipartUpload(params, request); ``` + +## Contribute +We love PRs! Check out the [contributing guidelines](CONTRIBUTING.md). If you want to contribute, but you are not sure where to start - look for [issues labeled `help wanted`](https://github.com/NativeScript/nativescript-background-http/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). + +## Get Help +Please, use [github issues](https://github.com/NativeScript/nativescript-background-http/issues) strictly for [reporting bugs](CONTRIBUTING.md#reporting-bugs) or [requesting features](CONTRIBUTING.md#requesting-new-features). For general questions and support, check out the [NativeScript community forum](https://discourse.nativescript.org/) or ask our experts in [NativeScript community Slack channel](http://developer.telerik.com/wp-login.php?action=slack-invitation). + +![](https://ga-beacon.appspot.com/UA-111455-24/nativescript/nativescript-background-http?pixel) +