docs: improve documentation around contribution (#10825)
This commit is contained in:
Sebastian Spaink
GitHub
parent
b9e66f8b9a
commit
1f7cd1d4a4
|
|
@ -1,4 +1,28 @@
|
|||
# Contributing
|
||||
# Contributing to Telegraf
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
## 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 ensure you include all the requested details (e.g. Telegraf config and logs, platform, etc.)
|
||||
|
||||
Please note that issues are not the place to file general support requests such as "How do I use the mongoDB plugin?" Questions of this nature should be sent to the [Community Slack](https://influxdata.com/slack) or [Community Page](https://community.influxdata.com/), not filed as issues.
|
||||
|
||||
### Feature requests
|
||||
|
||||
We really like to receive feature requests as it helps us prioritize our work. Before you file a feature request, please search existing issues, you can filter issues that have the label `feature request`. 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.
|
||||
|
||||
### 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.
|
||||
|
||||
## 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
|
||||
|
|
@ -16,11 +40,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.
|
||||
|
||||
|
|
@ -34,13 +58,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:
|
||||
|
||||
[](https://godoc.org/github.com/influxdata/telegraf)
|
||||
|
||||
## Common development tasks
|
||||
|
||||
**Adding a dependency:**
|
||||
|
|
|
|||
22
README.md
22
README.md
|
|
@ -1,10 +1,9 @@
|
|||
|
||||
# Telegraf
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://circleci.com/gh/influxdata/telegraf) [](https://hub.docker.com/_/telegraf/)
|
||||
[](https://www.influxdata.com/slack)
|
||||
[](#Contributing) [](https://www.influxdata.com/slack) [](https://circleci.com/gh/influxdata/telegraf) [](https://godoc.org/github.com/influxdata/telegraf) [](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
|
||||
|
|
@ -139,6 +138,12 @@ telegraf --config telegraf.conf
|
|||
telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
|
||||
```
|
||||
|
||||
## Contribute to the Project
|
||||
|
||||
Telegraf is an MIT licensed open source project and we love our community. The fastest way to get something fixed is to open a PR. Check out our [contributing guide](CONTRIBUTING.md) if you're interested in helping out. Also, join us on our [Community Slack](https://influxdata.com/slack) or [Community Page](https://community.influxdata.com/) if you have questions or comments for our engineering teams.
|
||||
|
||||
If your completely new to Telegraf and InfluxDB, you can also enroll for free at [InfluxDB university](https://www.influxdata.com/university/) to take courses to learn more.
|
||||
|
||||
## Documentation
|
||||
|
||||
[Latest Release Documentation](https://docs.influxdata.com/telegraf/latest/)
|
||||
|
|
@ -149,14 +154,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 not shown.
|
After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 7.6 KiB After Width: | Height: | Size: 7.6 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue