Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.44 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Prerequisites for running and testing code

These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.

  1. Install Go through download | through Homebrew
  2. Clone this repository.
  3. Build and test your changes in isolation.
  4. Submit your PR.

Note that the custom collector source is all generated using the OpenTelemetry collector builder tool, so we don't expect you to modify the generated source. We will regenerate that source from time to time as the OpenTelemetry project updates their tool and when dependent modules are updated.

We welcome PRs that do that accelerate keeping the sample collector up to date.

And, of course, we welcome PRs on the non-generated portions of the code. This includes the sample installers and useful collector configurations.

Submitting a pull request

  1. Clone the repository
  2. Make your changes and test, test, test.
  3. Make sure the collector tests pass on your machine: go test -v ./...
  4. Make sure the installer scripts work on your machine.
  5. Create a new branch: git checkout -b my-branch-name
  6. Push to your fork and submit a pull request.
  7. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources