Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 4.13 KB
Raw

Contributing to New Relic Dropwizard Reporter

Thanks for your interest in contributing to the New Relic Dropwizard Reporter! We look forward to engaging with you.

How to Contribute

How to Get Help or Ask Questions

Do you have questions or are you experiencing unexpected behaviors after modifying this Open Source Software? Please engage with the “Build on New Relic” space in the Explorers Hub, New Relic’s Forum. Posts are publicly viewable by anyone, please do not include PII or sensitive information in your forum post.

Contributor License Agreement ("CLA")

We'd love to get your contributions to improve New Relic Dropwizard Reporter! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. To execute our corporate CLA, which is required if your contribution is on behalf of a company, or if you have any questions, please drop us an email at open-source@newrelic.com.

Filing Issues & Bug Reports

We use GitHub issues to track public issues and bugs. If possible, please provide a link to an example app or gist that reproduces the issue. When filing an issue, please ensure your description is clear and includes the following information.

  • Project version (ex: 1.4.0)
  • Custom configurations (ex: flag=true)
  • Any modifications made to the New Relic Dropwizard Reporter

A note about vulnerabilities

New Relic is committed to the security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.

Setting Up Your Environment

This Open Source Software can be used in a large number of environments, all of which have their own quirks and best practices. As such, while we are happy to provide documentation and assistance for unmodified Open Source Software, we cannot provide support for your specific environment.

If you can build the New Relic Dropwizard Reporter, you can develop it!

Pull Request Guidelines

Before we can accept a pull request, you must sign our Contributor Licensing Agreement, if you have not already done so. This grants us the right to use your code under the same Apache 2.0 license as we use for this project in general.

Minimally, the test suite must pass for us to accept a PR.

Coding Style Guidelines

Our code base is formatted according to the Google Java Style Guide.

The project is configured to use the google-java-format-gradle-plugin which can be utilized as follows:

  • Execute the task googleJavaFormat to format all *.java files in the project:

./gradlew goJF

  • Execute the task verifyGoogleJavaFormat to verify that all *.java files are formatted properly:

./gradlew verGJF

Testing Guidelines

The New Relic Dropwizard Reporter includes the following tests which must pass:

src/test

Ideally, we would love it if you also added appropriate tests if you're implementing a feature!

License

By contributing to New Relic Dropwizard Reporter, you agree that your contributions will be licensed under the License file in the root directory of this source tree.