newrelic 6.10.0 → 6.11.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource@newrelic.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

package/CONTRIBUTING.md

@@ -1,41 +1,81 @@
-# Guidelines for contributing code
+# Guidelines for Contributing Code
 
 New Relic welcomes code contributions by the Node community to this module, and
 have taken effort to make this process easy for both contributors and our
 development team.
 
+## Process
+
+### Feature Requests
+
+Feature requests should be submitted in the [Issue tracker](../../issues), with
+a description of the expected behavior & use case. Before submitting an Issue,
+please search for similar ones in the [closed
+issues](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
+
+### Pull Requests
+
+We can only accept PRs for version v6.11.0 or greater due to open source
+licensing restrictions.
+
+### Code of Conduct
+
+Before contributing please read the [code of conduct](./CODE_OF_CONDUCT.md)
+
+Note that our [code of conduct](./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.
+
+### 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/.
+
+## The Code
+
+### Version Support
+
 When contributing, keep in mind that New Relic customers (that's you!) are
 running many different versions of Node, some of them pretty old. Changes that
 depend on the newest version of Node will probably be rejected, with prejudice
 if they replace something backwards compatible.
 
-Also be aware that the instrumentation needs to work with a wide range of
-versions of the instrumented modules, and that code that looks nonsensical or
+Be aware that the instrumentation needs to work with a wide range of versions
+of the instrumented modules, and that code that looks nonsensical or
 overcomplicated may be that way for compatibility-related reasons. Read all the
 comments and check the related tests before deciding whether existing code is
 incorrect.
 
-## Testing
+### Testing
 
 The agent includes a suite of unit and functional tests which should be used to
 verify your changes don't break existing functionality.
 
 Unit tests are stored in `test/`. They're written in
-[Mocha](https://mochajs.org), and have the extension
-`.test.js`.
+[node-tap](https://github.com/isaacs/node-tap), and have the extension `.test.js`.
 
 Generic functional tests are stored in `test/integration/`. They're written in
 [node-tap](https://github.com/isaacs/node-tap), and have the extension
 `.tap.js`.
 
-Functional tests against specific versions of instrumented modules are stored in
-`test/versioned/`. They are also written in `node-tap`.
+Functional tests against specific versions of instrumented modules are stored
+in `test/versioned/`. They are also written in `node-tap`.
 
-There are some other tests in `test/versioned-node/`. They are works in progress
-and not ready for general-purpose use.
-
-
-### Setup
+#### Setup
 
 To run the tests you need an openssl command-line binary, and some services:
 
@@ -53,30 +93,30 @@ If you use macOS or Windows, install [Docker Desktop]
 to download and launch docker containers for each of the above services.
 
 If you have these services available on non-standard ports or elsewhere on your
-network, you can use the following environment variables to tell the tests where
-they are:
+network, you can use the following environment variables to tell the tests
+where they are:
 
 * NR_NODE\_TEST_<service>\_HOST
 * NR_NODE\_TEST_<service>\_PORT
 
 The service token is the all-caps version of the service name listed above.
 
-### Running the tests
+#### Running the tests
 
-Running the test suite is simple.  Just run:
+Running the test suite is simple. Just run:
 
     npm test
 
-This will install all the necessary modules (and do any required SSL certificate
-creation) and run the unit tests in standalone mode, followed by the functional
-tests if all of the unit tests pass.
+This will install all the necessary modules (and do any required SSL
+certificate creation) and run the unit tests in standalone mode, followed by
+the functional tests if all of the unit tests pass.
 
 If you don't feel like dealing with the hassle of setting up the servers, just
 the unit tests can be run with:
 
     npm run unit
 
-### Writing tests
+#### Writing tests
 
 For most contributions it is strongly recommended to add additional tests which
 exercise your changes. This helps us efficiently incorporate your changes into
@@ -90,11 +130,3 @@ 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.
-
-## And finally...
-
-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.