From d0aeae27b3329a6fd1a0e941c158394b4afecbf9 Mon Sep 17 00:00:00 2001 From: Jordan Sissel Date: Mon, 16 Sep 2013 17:23:25 -0700 Subject: [PATCH] - add CONTRIBUTING docs --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 21 ++--------------- 2 files changed, 63 insertions(+), 19 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..99e6f382f82 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to logstash + +All contributions are welcome: ideas, patches, documentation, bug reports, +complaints, etc! + +Programming is not a required skill, and there are many ways to help out! +It is more important to us that you are able to contribute. + +That said, some basic guidelines, which you are free to ignore :) + +## Want to learn? + +Want to lurk about and see what others are doing with logstash? + +* The irc channel (#logstash on irc.freenode.org) is a good place for this +* The [mailing list](http://groups.google.com/group/logstash-users) is also + great for learning from others. + +## Got Questions? + +Have a problem you want logstash to solve for you? + +* You can email the [mailing list](http://groups.google.com/group/logstash-users) +* alternately, you are welcome to join the IRC channel #logstash on +irc.freenode.org and ask for help there! + +## Have an Idea or Feature Request? + +* File a ticket on [jira](https://logstash.jira.com/secure/Dashboard.jspa), or email the + [mailing list](http://groups.google.com/group/logstash-users), or email + me personally (jls@semicomplete.com) if that is more comfortable. + +## Something Not Working? Found a Bug? + +If you think you found a bug, it probably is a bug. + +* File it on [jira](https://logstash.jira.com/secure/Dashboard.jspa) +* or the [mailing list](http://groups.google.com/group/logstash-users). + +# Contributing Documentation and Code Changes + +If you have a bugfix or new feature that you would like to contribute to +logstash, and you think it will take more than a few minutes to produce the fix +(ie; write code), it is worth discussing the change with the logstash users and developers first! You can reach us via [jira](https://logstash.jira.com/secure/Dashboard.jspa), the [mailing list](http://groups.google.com/group/logstash-users), or via IRC (#logstash on freenode irc) + +## Contribution Steps + +1. Test your changes! Run the test suite ('make test') +2. Please make sure you have signed our [Contributor License + Agreement](http://www.elasticsearch.org/contributor-agreement/). We are not + asking you to assign copyright to us, but to give us the right to distribute + your code without restriction. We ask this of all contributors in order to + assure our users of the origin and continuing existence of the code. You + only need to sign the CLA once. +3. Send a pull request! Push your changes to your fork of the repository and + [submit a pull + request](https://help.github.com/articles/using-pull-requests). In the pull + request, describe what your changes do and mention any jira issues related + to the pull request. + + diff --git a/README.md b/README.md index e3f27cc3161..98cb22c39da 100755 --- a/README.md +++ b/README.md @@ -110,22 +110,5 @@ see that here. It is more important to me that you are able to contribute. -That said, some basic guidelines, which you are free to ignore :) - -* Have a problem you want logstash to solve for you? You can email the - [mailing list](http://groups.google.com/group/logstash-users), or - join the IRC channel #logstash on irc.freenode.org, or email me personally - (jls@semicomplete.com) -* Have an idea or a feature request? File a ticket on - [jira](https://logstash.jira.com/secure/Dashboard.jspa), or email the - [mailing list](http://groups.google.com/group/logstash-users), or email - me personally (jls@semicomplete.com) if that is more comfortable. -* If you think you found a bug, it probably is a bug. File it on - [jira](https://logstash.jira.com/secure/Dashboard.jspa) or send details to - the [mailing list](http://groups.google.com/group/logstash-users). -* If you want to send patches, best way is to fork this repo and send me a pull - request. If you don't know git, I also accept diff(1) formatted patches - - whatever is most comfortable for you. -* Want to lurk about and see what others are doing? IRC (#logstash on - irc.freenode.org) is a good place for this as is the - [mailing list](http://groups.google.com/group/logstash-users) +For more information about contributing, see the +(CONTRIBUTING)[CONTRIBUTING.md] file.