Skip to content

Commit

Permalink
[NR-56625] OSS refine (#35)
Browse files Browse the repository at this point in the history
* [NR-56625] Add header, cleanup README
  • Loading branch information
ywang-nr authored Nov 1, 2022
1 parent 06a59eb commit 28b2909
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 16 deletions.
30 changes: 29 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 [email protected].

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/.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
5 changes: 1 addition & 4 deletions src/android/NewRelicCordovaPlugin.java
Original file line number Diff line number Diff line change
@@ -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
//

Expand Down
6 changes: 1 addition & 5 deletions src/ios/NewRelicCordovaPlugin.h
Original file line number Diff line number Diff line change
@@ -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
//

Expand Down
5 changes: 1 addition & 4 deletions src/ios/NewRelicCordovaPlugin.m
Original file line number Diff line number Diff line change
@@ -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
//

Expand Down

0 comments on commit 28b2909

Please sign in to comment.