-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* adding xcframework latest agent * Adding Static Methods for testing * fixing reference issue * Add Static Methods for Cordova Plugin * Add Static Methods for Cordova Plugin * Add Static Methods for Cordova Plugin * Adding Methods for conso;e logs,Error Handler and Promise Rejection * Adding typescript methods for cordova ionic plugin * Adding console instrumentation * feat: added missing static methods * feat: Add static methods for setting feature flags * docs: Update README with usage and fixes for consistency * Adding Newrelic agent as pod depedency * fix: Fix null errors from JS to ios plugin * docs: Add instructions for usage in JS and TS * Update LICENSE * Update README.md * test: Add skeleton for cordova-paramedic testing * test: Fix installation tests and move all tests to single folder * removing newrelic framework and adding static methods to support typescript * chore:Adding formatting in cordova plugin * chore:updating documenats for open source contribution * Delete .gitignore * Delete misc.xml * Delete modules.xml * Delete vcs.xml Co-authored-by: Kenny <[email protected]> Co-authored-by: kthai-nr <[email protected]>
- Loading branch information
3 people
authored
Nov 1, 2022
1 parent
28b2909
commit eb648e1
Showing
258 changed files
with
6,576 additions
and
43,769 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,68 @@ | ||
| # Guidelines for Contributing Code | ||
| # Contributing | ||
|
|
||
| At New Relic we welcome community code contributions our open source project, | ||
| 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. | ||
|
|
||
| ## Feature Requests | ||
|
|
||
| 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/). | ||
|
|
||
| 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 | ||
|
|
||
| ## 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/. | ||
|
|
||
| ## Testing | ||
| ### Functional Testing | ||
| The plugin includes a suite of functional tests which should be used to | ||
| verify your changes don't break existing functionality. | ||
|
|
||
| Functional tests are stored in the `test` directory. | ||
|
|
||
| ### Running Tests | ||
|
|
||
| Running the test suite is simple. Just invoke: | ||
|
|
||
| ``` | ||
| npm install | ||
| npm test | ||
| ``` | ||
|
|
||
| This will run the tests in standalone mode, executing the test suite. | ||
| ### Unit Testing | ||
| The plugin includes unit testing that is stored in the `tests` directory. | ||
|
|
||
| Our testing makes use of [cordova-paramedic](https://github.com/apache/cordova-paramedic) to run our tests in a test app in an emulator. The npm version of cordova-paramedic is out of date, so it is preferred to install it using GitHub. To install it, run: | ||
| ``` | ||
| npm install -g github:apache/cordova-paramedic | ||
| ``` | ||
| Once it is installed, you will be able to run tests for each individual platform. | ||
| ``` | ||
| npm run test:android | ||
| npm run test:ios | ||
| ``` | ||
|
|
||
|
|
||
| ### Writing Tests | ||
|
|
||
|
|
@@ -38,30 +75,4 @@ and provides a safeguard that your change won't be broken by future development. | |
| There are some rare cases where code changes do not result in changed | ||
| 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. | ||
|
|
||
|
|
||
| ## 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/. | ||
| chances it will be accepted. | ||
Oops, something went wrong.