CONTRIBUTING.md 2.53 KB
Newer Older
Jordan Sissel's avatar
Jordan Sissel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
# Contributing to lumberjack

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 and lumberjack? 

* 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 or a question?
 
* 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://github.com/jordansissel/lumberjack), 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://github.com/jordansissel/lumberjack)
* 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://github.com/jordansissel/lumberjack), 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 open issues related
   to the pull request.