From 28b2909cc326a320850bfe234af8ccab754b4285 Mon Sep 17 00:00:00 2001 From: ywang-nr <84047247+ywang-nr@users.noreply.github.com> Date: Tue, 1 Nov 2022 16:02:17 -0400 Subject: [PATCH] [NR-56625] OSS refine (#35) * [NR-56625] Add header, cleanup README --- CONTRIBUTING.md | 30 +++++++++++++++++++++++++- README.md | 6 ++++-- src/android/NewRelicCordovaPlugin.java | 5 +---- src/ios/NewRelicCordovaPlugin.h | 6 +----- src/ios/NewRelicCordovaPlugin.m | 5 +---- 5 files changed, 36 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0991510..79120dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,12 @@ and have taken effort to make this process easy for both contributors and our development team. Because of this, we need to be more defensive in our coding practices than most projects. +Contributions are always welcome. Before contributing please read the +[code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) and [search the issue tracker](issues); your issue may have already been discussed or fixed in `main`. To contribute, +[fork](https://help.github.com/articles/fork-a-repo/) this repository, commit your changes, and [send a Pull Request](https://help.github.com/articles/using-pull-requests/). + +Note that our [code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants. + ## Testing The plugin includes a suite of functional tests which should be used to @@ -34,6 +40,28 @@ functionality (e.g. a performance optimization) and new tests are not required. In general, including tests with your pull request dramatically increases the chances it will be accepted. -### And Finally... + +## Feature Requests You are welcome to send pull requests to us - however, by doing so you agree that you are granting New Relic a non-exclusive, non-revokable, no-cost license to use the code, algorithms, patents, and ideas in that code in our products if we so choose. You also agree the code is provided as-is and you provide no warranties as to its fitness or correctness for any purpose. + +Feature requests should be submitted in the [Issue tracker](../../issues), with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, [e.g. :+1: reactions](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/), has been [shown by the community](../../issues?q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc). +Before submitting an Issue, please search for similar ones in the +[closed issues](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement). + +## Pull Requests + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. +2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. + +## Contributor License Agreement + +Keep in mind that when you submit your Pull Request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com. + +For more information about CLAs, please check out Alex Russell’s excellent post, +[“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/). + +## Slack + +We host a public Slack with a dedicated channel for contributors and maintainers of open source projects hosted by New Relic. If you are contributing to this project, you're welcome to request access to the #oss-contributors channel in the newrelicusers.slack.com workspace. To request access, see https://newrelicusers-signup.herokuapp.com/. diff --git a/README.md b/README.md index 6d8777d..a1006c2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ +[![Community Plus header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus) + # New Relic plugin for Cordova > The official [New Relic](https://newrelic.com/mobile-monitoring) [Cordova](http://cordova.apache.org/) plugin for iOS and Android. # When added the New Relic Cordova plugin will -* Detect the platforms added to your Cordova application and apply the most recent release of the appropriate New Relic Mobile agent ([Android ](http://docs.newrelic.com/docs/releases/android), [iOS ](http://docs.newrelic.com/docs/releases/ios)) +* Detect the platforms added to your Cordova application and apply the most recent release of the appropriate New Relic Mobile agent ([Android ](http://docs.newrelic.com/docs/releases/android), [iOS ](https://docs.newrelic.com/docs/release-notes/mobile-release-notes/xcframework-release-notes/)) * Add post-build scripts for uploading iOS symbolication files * Upload Android Proguard mapping files * Automatically instrument mobile applications built via Cordova @@ -44,7 +46,7 @@ Following these helps us efficiently review and incorporate your contribution an # License -Copyright (c) 2017 New Relic. All rights reserved. +Copyright (c) 2017 - Present New Relic. All rights reserved. For New Relic agent license details see: * https://docs.newrelic.com/docs/licenses/ios-agent-licenses * https://docs.newrelic.com/docs/licenses/android-agent-licenses diff --git a/src/android/NewRelicCordovaPlugin.java b/src/android/NewRelicCordovaPlugin.java index 98137a4..7638781 100644 --- a/src/android/NewRelicCordovaPlugin.java +++ b/src/android/NewRelicCordovaPlugin.java @@ -1,9 +1,6 @@ // New Relic for Mobile -- Android edition // -// See: -// https://docs.newrelic.com/docs/releases/android for release notes -// -// Copyright (c) 2021 New Relic. All rights reserved. +// Copyright (c) 2017 - Present New Relic. All rights reserved. // See https://docs.newrelic.com/docs/licenses/android-agent-licenses for license details // diff --git a/src/ios/NewRelicCordovaPlugin.h b/src/ios/NewRelicCordovaPlugin.h index 994ba9c..264da63 100644 --- a/src/ios/NewRelicCordovaPlugin.h +++ b/src/ios/NewRelicCordovaPlugin.h @@ -1,10 +1,6 @@ // New Relic for Mobile -- iOS edition // -// See: -// https://docs.newrelic.com/docs/mobile-apps for information -// https://docs.newrelic.com/docs/releases/ios for release notes -// -// Copyright (c) 2014 New Relic. All rights reserved. +// Copyright (c) 2017 - Present New Relic. All rights reserved. // See https://docs.newrelic.com/docs/licenses/ios-agent-licenses for license details // diff --git a/src/ios/NewRelicCordovaPlugin.m b/src/ios/NewRelicCordovaPlugin.m index 1995921..c30eb7c 100644 --- a/src/ios/NewRelicCordovaPlugin.m +++ b/src/ios/NewRelicCordovaPlugin.m @@ -1,9 +1,6 @@ // New Relic for Mobile -- iOS edition // -// See: -// https://docs.newrelic.com/docs/releases/ios for release notes -// -// Copyright (c) 2017 New Relic. All rights reserved. +// Copyright (c) 2017 - Present New Relic. All rights reserved. // See https://docs.newrelic.com/docs/licenses/ios-agent-licenses for license details //