Skip to content

Latest commit

 

History

History
112 lines (81 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

112 lines (81 loc) · 4.36 KB
Raw

Contributing

  1. Sign the CLA.
  2. Open a new issue to discuss the changes you would like to make. This is not strictly required but it may help reduce the amount of rework you need to do later.
  3. Make changes or write plugin using the guidelines in the following documents:
  4. Ensure you have added proper unit tests and documentation.
  5. Open a new pull request.
  6. The pull request title needs to follow conventional commit format

Note: If you have a pull request with only one commit, then that commit needs to follow the conventional commit format or the Semantic Pull Request check will fail. This is because github will use the pull request title if there are multiple commits, but if there is only one commit it will use it instead.

When will your contribution get released?

We have two kinds of releases: patch releases, which happen every few weeks, and feature releases, which happen once a quarter. If your fix is a bug fix, it will be released in the next patch release after it is merged to master. If your release is a new plugin or other feature, it will be released in the next quarterly release after it is merged to master. Quarterly releases are on the third Wednesday of March, June, September, and December.

Contributing an External Plugin

Input, output, and processor plugins written for internal Telegraf can be run as externally-compiled plugins through the Execd Input, Execd Output, and Execd Processor Plugins without having to change the plugin code.

Follow the guidelines of how to integrate your plugin with the Execd Go Shim to easily compile it as a separate app and run it with the respective execd plugin. Check out our guidelines on how to build and set up your external plugins to run with execd.

Security Vulnerability Reporting

InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our open source projects, please responsibly disclose it by contacting security@influxdata.com. More details about security vulnerability reporting, including our GPG key, can be found here.

GoDoc

Public interfaces for inputs, outputs, processors, aggregators, metrics, and the accumulator can be found in the GoDoc:

GoDoc

Common development tasks

Adding a dependency:

Telegraf uses Go modules. Assuming you can already build the project, run this in the telegraf directory:

  1. go get github.com/[dependency]/[new-package]

Unit Tests:

Before opening a pull request you should run the linter checks and the short tests.

make check
make test

Execute integration tests:

(Optional)

Running the integration tests requires several docker containers to be running. You can start the containers with:

docker-compose up

To run only the integration tests use:

make test-integration

To run the full test suite use:

make test-all

Use make docker-kill to stop the containers.

For more developer resources