Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 2.73 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 within your trace2receiver component.
  4. Submit your PR.

Of course the whole point of this is to run your trace2receiver component within a custom collector and generate some data, so you should also test it in that context. See Building and Configuration.

  1. Create an OpenTelemetry Custom Collector using the builder tool in a new peer repository that references the trace2receiver component.
  2. The go.mod file in your collector should reference the public version of the trace2receiver component. You may need to use a replace to redirect GO to your development version for testing.
  3. Build and test your component changes running under a collector.

Your custom collector should not be included in your PR; just changes to the trace2receiver component.

Submitting a pull request

  1. Clone the repository
  2. Make sure the tests pass on your machine: go test -v ./...
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change, add tests, and make sure the tests still pass
  5. Push to your fork and submit a pull request.
  6. 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