From ebe6205e50e8d0dd98f7ce7b69cf82e985332589 Mon Sep 17 00:00:00 2001 From: Sefa Ilkimen Date: Tue, 24 Oct 2017 17:00:40 +0200 Subject: [PATCH] add contribution guidelines --- CONTRIBUTING.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 86 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..97dfe7b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Contributing to Advanced HTTP Plugin + +We'd love for you to contribute to our source code and to make Advanced HTTP even better than it is +today! Here are the guidelines we'd like you to follow: + + - [Issues and Bugs](#issue) + - [Feature Requests](#feature) + - [Submission Guidelines](#submit) + +## Found an Issue? + +If you find a bug in the source code or a mistake in the documentation, you can help us by +submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request +with a fix. + +## Want a Feature? + +You can request a new feature by submitting an issue to our [GitHub Repository][github]. If you +would like to implement a new feature then consider what kind of change it is: + +* **Major Changes** that you wish to contribute to the project should be discussed first so that we + can better coordinate our efforts, prevent duplication of work, and help you to craft the change + so that it is successfully accepted into the project. Please submit an issue to our + [GitHub Repository][github] for discussion. +* **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a Pull + Request. + +## Submission Guidelines + +### Submitting an Issue +Before you submit your issue search the archive, maybe your question was already answered. + +If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize +the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. +Providing the following information will increase the chances of your issue being dealt with +quickly: + +* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps +* **Motivation for or Use Case** - explain why this is a bug for you +* **Advanced HTTP Version(s)** - is it a regression? +* **Operating System** - is this a problem with all supported OS or only specific ones? +* **Related Issues** - has a similar issue been reported before? +* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be + causing the problem (line of code or commit) + +**If you get help, help others. Good karma rulez!** + +### Submitting a Pull Request +Before you submit your pull request consider the following guidelines: + +* Search [GitHub](https://github.com/silkimen/cordova-plugin-advanced-http/pulls) for an open or + closed Pull Request that relates to your submission. You don't want to duplicate effort. +* Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch master + ``` +* Create your patch +* Commit your changes using a descriptive commit message +* Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +In GitHub, send a pull request to `cordova-plugin-advanced-http:master`. +If we suggest changes or the [CI build fails](#cibuild), then: + +* Make the required updates. +* Commit your changes to your branch (e.g. `my-fix-branch`). +* Push the changes to your GitHub repository (this will update your Pull Request). + +That's it! Thank you for your contribution! + +### Pull Request Feedback +You can always check the results of the latest CI builds on +[Travis CI](https://travis-ci.org/silkimen/cordova-plugin-advanced-http/). +You can use this information to inspect failing tests in your PR. + +## Attribution +This document is adapted from +[AngularJS' Contribution Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md) diff --git a/README.md b/README.md index ef7a3bf..520980d 100644 --- a/README.md +++ b/README.md @@ -234,3 +234,7 @@ This plugin utilizes some awesome open source networking libraries. These are bo - Android - [http-request](https://github.com/kevinsawicki/http-request) We made a few modifications to both of them. + +## Contribute & Develop + +We've set up a separate document for our [contribution guidelines](CONTRIBUTING.md).