Skip to content

Latest commit

 

History

History
230 lines (176 loc) · 8.86 KB

CONTRIBUTING.rst

File metadata and controls

230 lines (176 loc) · 8.86 KB
Raw

Contributing to the Python Agent

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

How to Contribute

Contributions are always welcome. Before contributing please read the code of conduct and search the issue tracker; your issue may have already been discussed or fixed in main. To contribute, fork this repository, commit your changes, and send a Pull Request.

Note that our code of conduct applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants.

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 the Python Agent! Keep in mind that 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. 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?.

Feature Requests

Feature requests should be submitted in the Issue tracker, with a description of the expected behavior & use case, where they'll remain closed until sufficient interest, e.g. 👍 reactions, has been shown by the community. Before submitting an Issue, please search for similar ones in the closed issues.

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 Python Agent

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.

Developing Inside a Container

To avoid the issues involved with setting up a local environment, consider using our prebuilt development container to easily create an environment on demand with a wide selection of Python versions installed. This also comes with the tox tool (See Testing Guidelines) and a few packages preinstalled.

While we cannot provide direct support in setting up your environment to work with this container, we develop it in the open and provide this documentation to help reduce the setup burden on new contributors.

Prerequisites:

  1. Install Docker for you local operating system.
  2. Login to the GitHub Container Registry through Docker.
  3. Install Either:

Steps for VS Code:

  1. Ensure Docker is running.
  2. Install the VS Code Extension for Dev Containers into VS Code.
  3. In VS Code, open the command pallette (Ctrl-Shift-P on Windows/Linux or Cmd-Shift-P on Mac) and search for and run "Dev Containers: Rebuild and Reopen in Container".
  4. Wait for the container to build and start. This may take a long time to pull the first time the container is run, subsequent runs should be faster thanks to caching.
  5. To update your container, open the command pallette and run "Dev Containers: Rebuild Without Cache and Reopen in Container".

Steps for Command Line Editor Users (vim, etc.):

  1. Ensure Docker is running.
  2. From the root of this repository, run devcontainer up --workspace-folder=. to start the container. The running container ID will be displayed, which is useful for subsequent steps.
  3. To gain shell access to the container, run docker exec -it <container-id> /bin/bash. Alternative shells include zsh and fish.
  4. Navigate to the /workspaces folder to find your source code.
  5. To stop the container, run exit on any open shells and then run docker stop <container-id>. docker ps may be helpful for finding the ID if you've lost it.

Personalizing Your Container:

  1. If you use a dotfiles repository (such as chezmoi), you can configure your container to clone and install your dotfiles using VS Code dotfile settings.
  2. To install extra packages and features, you can edit your local copy of the .devcontainer/devcontainer.json file to use specific Dev Container Features. A few common needs are already included but commented out.

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. Ideally, we would love it if you also added appropriate tests if you're implementing a feature!

Please note that integration tests will be run internally before contributions are accepted.

Additionally:

  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.
  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.

Testing Guidelines

The Python Agent uses tox for testing. The repository uses tests in tests/.

You can run these tests by entering the tests/ directory and then entering the directory of the tests you want to run. Then, run the following command:

tox -c tox.ini -e [test environment]