Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve documentation around contribution #10825

Merged
merged 15 commits into from
Mar 28, 2022
41 changes: 31 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,32 @@
# Contributing
# Contributing to Telegraf

Telegraf is a large open-source project and there are multiple ways to contribute.
There are many ways to get involved in the Telegraf project! From opening issues, creating pull requests, to joining the conversation in Slack. We would to see you contribute your expertise and join our community. To get started review this document to learn best practices.
sspaink marked this conversation as resolved.
Show resolved Hide resolved

![tiger](assets/GopherAndTiger.png "tiger")

## Opening Issues

### Bug reports

Before you file an issue, please search existing issues in case it has already been filed, or perhaps even fixed. If you file an issue, please include the following.
sspaink marked this conversation as resolved.
Show resolved Hide resolved

- Full details of your operating system (or distribution) e.g. 64bit Ubuntu 18.04.
- The version of Telegraf you are running
- Whether you installed it using a pre-built package, or built it from source.
- Clear steps to reproduce the issue described, if at all possible.

sspaink marked this conversation as resolved.
Show resolved Hide resolved
### Feature requests

We really like to receive feature requests as it helps us prioritize our work. Please be clear about your requirements and goals, help us to understand what you would like to see added to Telegraf with examples and the reasons why it is important to you. If you find your feature request already exists as a Github issue please indicate your support for that feature by using the "thumbs up" reaction.
sspaink marked this conversation as resolved.
Show resolved Hide resolved

### Support questions

We recommend posting support questions in our [Community Slack](https://influxdata.com/slack) or [Community Page](https://community.influxdata.com/), we have a lot of talented community members there who could help answer your question more quickly.
sspaink marked this conversation as resolved.
Show resolved Hide resolved

## Contributing code

### Creating a pull request

1. [Sign the CLA][cla].
2. Open a [new issue][] to discuss the changes you would like to make. This is
Expand All @@ -16,11 +44,11 @@

**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?
### 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
### Contributing an External Plugin

Input, output, and processor plugins written for internal Telegraf can be run as externally-compiled plugins through the [Execd Input](/plugins/inputs/execd), [Execd Output](/plugins/outputs/execd), and [Execd Processor](/plugins/processors/execd) Plugins without having to change the plugin code.

Expand All @@ -34,13 +62,6 @@ open source projects, please responsibly disclose it by contacting security@infl
security vulnerability reporting,
including our GPG key, [can be found here](https://www.influxdata.com/how-to-report-security-vulnerabilities/).

## GoDoc

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

[![GoDoc](https://godoc.org/github.com/influxdata/telegraf?status.svg)](https://godoc.org/github.com/influxdata/telegraf)

## Common development tasks

**Adding a dependency:**
Expand Down
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@

# Telegraf

![tiger](TelegrafTiger.png "tiger")
![tiger](assets/TelegrafTiger.png "tiger")

[![Circle CI](https://circleci.com/gh/influxdata/telegraf.svg?style=svg)](https://circleci.com/gh/influxdata/telegraf) [![Docker pulls](https://img.shields.io/docker/pulls/library/telegraf.svg)](https://hub.docker.com/_/telegraf/)
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.influxdata.com/slack)
[![Contribute](https://img.shields.io/badge/Contribute%20To%20Telegraf-orange.svg?logo=influx&style=for-the-badge)](#Contributing) [![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=for-the-badge)](https://www.influxdata.com/slack) [![Circle CI](https://circleci.com/gh/influxdata/telegraf.svg?style=svg)](https://circleci.com/gh/influxdata/telegraf) [![GoDoc](https://godoc.org/github.com/influxdata/telegraf?status.svg)](https://godoc.org/github.com/influxdata/telegraf) [![Docker pulls](https://img.shields.io/docker/pulls/library/telegraf.svg)](https://hub.docker.com/_/telegraf/)

Telegraf is an agent for collecting, processing, aggregating, and writing metrics. Based on a
plugin system to enable developers in the community to easily add support for additional
Expand Down Expand Up @@ -139,6 +138,19 @@ telegraf --config telegraf.conf
telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
```

## Contributing

There are multiple great ways to get involved with the Telegraf project, from contributing code to sharing your story on how you use it.

- Fix and [report bugs](https://github.com/influxdata/telegraf/issues/new)
- [Improve documentation](https://github.com/influxdata/telegraf/issues?q=is%3Aopen+label%3Adocumentation)
sspaink marked this conversation as resolved.
Show resolved Hide resolved
- [Review code and feature proposals](https://github.com/influxdata/telegraf/pulls)
sspaink marked this conversation as resolved.
Show resolved Hide resolved
- Answer questions and discuss here on github and on the [Community Site](https://community.influxdata.com/)
- [Contribute plugins](CONTRIBUTING.md)
sspaink marked this conversation as resolved.
Show resolved Hide resolved
- [Contribute external plugins](docs/EXTERNAL_PLUGINS.md)

Checkout our [Contributing Doc](CONTRIBUTING.md) to find out more!

## Documentation

[Latest Release Documentation](https://docs.influxdata.com/telegraf/latest/)
Expand All @@ -149,14 +161,3 @@ For documentation on the latest development code see the [documentation index](/
- [Output Plugins](/docs/OUTPUTS.md)
- [Processor Plugins](/docs/PROCESSORS.md)
- [Aggregator Plugins](/docs/AGGREGATORS.md)

## Contributing

There are many ways to contribute:

- Fix and [report bugs](https://github.com/influxdata/telegraf/issues/new)
- [Improve documentation](https://github.com/influxdata/telegraf/issues?q=is%3Aopen+label%3Adocumentation)
- [Review code and feature proposals](https://github.com/influxdata/telegraf/pulls)
- Answer questions and discuss here on github and on the [Community Site](https://community.influxdata.com/)
- [Contribute plugins](CONTRIBUTING.md)
- [Contribute external plugins](docs/EXTERNAL_PLUGINS.md)
Binary file added assets/GopherAndTiger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion cmd/telegraf/telegraf_windows.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//go:build windows
// +build windows

//go:generate goversioninfo -icon=../../assets/tiger.ico
//go:generate goversioninfo -icon=../../assets/windows/tiger.ico

package main

Expand Down
2 changes: 1 addition & 1 deletion scripts/mac-signing.sh
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ do
printf "\n"

cp ~/project/info.plist "$RootAppDir"
cp ~/project/assets/icon.icns "$RootAppDir/Resources"
cp ~/project/assets/windows/icon.icns "$RootAppDir/Resources"

chmod +x "$RootAppDir/MacOS/telegraf_entry_mac"

Expand Down