Skip to content

Commit

Permalink
- add CONTRIBUTING docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jordansissel committed Sep 17, 2013
1 parent 89a4412 commit d0aeae2
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 19 deletions.
61 changes: 61 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 ([email protected]) 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.


21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
([email protected])
* 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 ([email protected]) 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.

0 comments on commit d0aeae2

Please sign in to comment.