|
| 1 | +# Contributing to Logstash |
| 2 | + |
| 3 | +All contributions are welcome: ideas, patches, documentation, bug reports, |
| 4 | +complaints, etc! |
| 5 | + |
| 6 | +Programming is not a required skill, and there are many ways to help out! |
| 7 | +It is more important to us that you are able to contribute. |
| 8 | + |
| 9 | +That said, some basic guidelines, which you are free to ignore :) |
| 10 | + |
| 11 | +## Want to learn? |
| 12 | + |
| 13 | +Want to lurk about and see what others are doing with Logstash? |
| 14 | + |
| 15 | +* The irc channel (#logstash on irc.freenode.org) is a good place for this |
| 16 | +* The [forum](https://discuss.elastic.co/c/logstash) is also |
| 17 | + great for learning from others. |
| 18 | + |
| 19 | +## Got Questions? |
| 20 | + |
| 21 | +Have a problem you want Logstash to solve for you? |
| 22 | + |
| 23 | +* You can ask a question in the [forum](https://discuss.elastic.co/c/logstash) |
| 24 | +* Alternately, you are welcome to join the IRC channel #logstash on |
| 25 | +irc.freenode.org and ask for help there! |
| 26 | + |
| 27 | +## Have an Idea or Feature Request? |
| 28 | + |
| 29 | +* File a ticket on [GitHub](https://github.com/elastic/logstash/issues). Please remember that GitHub is used only for issues and feature requests. If you have a general question, the [forum](https://discuss.elastic.co/c/logstash) or IRC would be the best place to ask. |
| 30 | + |
| 31 | +## Something Not Working? Found a Bug? |
| 32 | + |
| 33 | +If you think you found a bug, it probably is a bug. |
| 34 | + |
| 35 | +* If it is a general Logstash or a pipeline issue, file it in [Logstash GitHub](https://github.com/elasticsearch/logstash/issues) |
| 36 | +* If it is specific to a plugin, please file it in the respective repository under [logstash-plugins](https://github.com/logstash-plugins) |
| 37 | +* or ask the [forum](https://discuss.elastic.co/c/logstash). |
| 38 | + |
| 39 | +# Contributing Documentation and Code Changes |
| 40 | + |
| 41 | +If you have a bugfix or new feature that you would like to contribute to |
| 42 | +logstash, and you think it will take more than a few minutes to produce the fix |
| 43 | +(ie; write code), it is worth discussing the change with the Logstash users and developers first! You can reach us via [GitHub](https://github.com/elastic/logstash/issues), the [forum](https://discuss.elastic.co/c/logstash), or via IRC (#logstash on freenode irc) |
| 44 | +Please note that Pull Requests without tests will not be merged. If you would like to contribute but do not have experience with writing tests, please ping us on IRC/forum or create a PR and ask our help. |
| 45 | + |
| 46 | +## Contributing to plugins |
| 47 | + |
| 48 | +Check our [documentation](https://www.elastic.co/guide/en/logstash/current/contributing-to-logstash.html) on how to contribute to plugins or write your own! It is super easy! |
| 49 | + |
| 50 | +## Contribution Steps |
| 51 | + |
| 52 | +1. Test your changes! [Run](https://github.com/elastic/logstash#testing) the test suite |
| 53 | +2. Please make sure you have signed our [Contributor License |
| 54 | + Agreement](https://www.elastic.co/contributor-agreement/). We are not |
| 55 | + asking you to assign copyright to us, but to give us the right to distribute |
| 56 | + your code without restriction. We ask this of all contributors in order to |
| 57 | + assure our users of the origin and continuing existence of the code. You |
| 58 | + only need to sign the CLA once. |
| 59 | +3. Send a pull request! Push your changes to your fork of the repository and |
| 60 | + [submit a pull |
| 61 | + request](https://help.github.com/articles/using-pull-requests). In the pull |
| 62 | + request, describe what your changes do and mention any bugs/issues related |
| 63 | + to the pull request. |
| 64 | + |
| 65 | + |
0 commit comments