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
Prev Previous commit
Next Next commit
chore: wordsmith contributing.md
  • Loading branch information
Sebastian Spaink committed Mar 15, 2022
commit f561aac0fe18989e1035e587b38d8b42ba544da5
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Contributing

Telegraf is a large open-source project and there are multiple ways to contribute.

- [Contributing Code](#contributing-code)
- [Contributing External Plugins](#contributing-an-external-plugin)
- Sharing your story on how you use Telegraf through blogs
- [Improve documentation](https://github.com/influxdata/telegraf/issues?q=is%3Aopen+label%3Adocumentation)

## Contributing code

1. [Sign the CLA][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
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

![tiger](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-green.svg)](#Contributing)
[![Contribute](https://img.shields.io/badge/Contribute%20To%20Telegraf-green.svg)](#Contributing) [![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](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 @@ -160,3 +160,5 @@ There are multiple great ways to get involved with the Telegraf project, from co
- 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!