Contributing to Fluentd

We'd love your contribution. Here are the guidelines!

Got a question or problem?

Resources of Official site and Fluentd documentation may help you.

If you have further questions about Fluentd and plugins, please direct these to Q & A category in GitHub Discussions.

Don't use GitHub issue for asking questions. Here are examples:

• installed xxx plugin but it doesn't work. Why?
• Fluentd starts but logs are not sent to xxx. Am I wrong?
• I want to do xxx. How to realize it with plugins?

We may close such questions to keep clear repository for developers and users. GitHub issue is mainly for submitting a bug report or feature request. See below.

If you can't judge your case is a bug or not, use slack first.

Found a bug?

If you find a bug of Fluentd or a mistake in the documentation, you can help us by submitting an issue to Fluentd. Even better you can submit a Pull Request with a fix.

• Fluentd: Use Fluentd repository. Fill issue template.
• Documentation: Use Fluentd-Docs repository. Fill issue template.

If you find a bug of 3rd party plugins, please submit an issue to each plugin repository. And use fluent-package-builder repository for fluent-package releated issues.

Patch Guidelines

Here are some things that would increase a chance that your patch is accepted:

• Write tests
• Run tests before send Pull Request by bundle exec rake test
• Write a good commit message

There are some patches which are hard to write tests, e.g. process handling, concurrency issue or etc. In such case, please don't hesitate to submit a Pull Request. We can discuss how to manage a patch on Pull Request :)