Thank you very much for considering contributing to the Graylog2 project! We <3 our community.
To make handling all the community contributions as easy as possible for us we ask you to follow these steps as good as possible:
- Please sign the TORCH Contributor Agreement if your issue contains any code. We cannot go on without this.
- Search the issues of the gelfclient repository for opened or closed issues to avoid duplicating effort.
- Be clear about the issue. It is always better to include too much information than too little. Include screenshots explaining the problem if you can.
- Always include the versions of affected Graylog2 components you are running.
- Provide exact steps to reproduce the issue if at any possible.
- Please sign the TORCH Contributor Agreement before sending pull requests. We cannot accept code without this.
- Search the issues of the gelfclient repository for opened or closed issues to avoid duplicating effort.
- Contact the TORCH team via any communication channel (contact form, mailing list, IRC, Github issue tracker) before working on a big change to make sure that there are chances of acceptance.
- Include tests if at any possible.
- Submit the pull request.
We are always happy about any feature request! Do not hesitate to create as many feature request issues as you want.
- Please sign the TORCH Contributor Agreement if your issue contains any code. We cannot go on without this.
- Search the issues of the gelfclient repository for opened or closed issues to avoid duplicating effort.
- Explain exactly what feature you would like to see and always include a use case for why you think it is useful.
Please make sure to follow the code style of the existing code. Most contributors are using the default code formatter of IntelliJ IDEA.
- Mailing List
- IRC channel #graylog2 on Freenode
Read more about best practices in this GitHub guide