Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.16 KB
Raw

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 Mailing List. Don't use Github issue for asking questions. Here are examples:

  • I 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 mailing list or 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.

If you find a bug of 3rd party plugins, please submit an issue to each plugin repository. And use omnibus-td-agent repository for td-agent related issues.

Note: Before report the issue, check latest version first. Sometimes users report fixed bug with older version.

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.
    • Fluentd repositories needs DCO on PR. Please add Signed-off-by to the commit(See DCO link for more detail).

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 :)