2015-04-27 11:41:55 -05:00
|
|
|
## Contributing to Caddy
|
|
|
|
|
|
2015-12-17 10:37:16 -05:00
|
|
|
**[Join our dev chat on Gitter](https://gitter.im/mholt/caddy)** to chat with
|
|
|
|
|
other Caddy developers! (Dev chat only; try our
|
|
|
|
|
[support room](https://gitter.im/caddyserver/support) for help or
|
|
|
|
|
[general](https://gitter.im/caddyserver/general) for anything else.)
|
2015-05-06 17:39:58 -05:00
|
|
|
|
2015-11-24 14:09:35 -05:00
|
|
|
This project gladly accepts contributions and we encourage interested users to
|
|
|
|
|
get involved!
|
2015-04-27 11:41:55 -05:00
|
|
|
|
2015-05-22 12:08:24 -05:00
|
|
|
|
|
|
|
|
#### For small tweaks, bug fixes, and tests
|
|
|
|
|
|
2015-11-24 14:09:35 -05:00
|
|
|
Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time.
|
2015-12-17 10:37:16 -05:00
|
|
|
Bug fixes should be under test to assert correct behavior. Thank you for
|
|
|
|
|
helping out in simple ways!
|
2015-05-22 12:08:24 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Ideas, questions, bug reports
|
|
|
|
|
|
2015-12-17 16:12:22 -05:00
|
|
|
Feel free to [open an issue](https://github.com/mholt/caddy/issues) with your
|
2015-12-17 10:37:16 -05:00
|
|
|
ideas, questions, and bug reports, if one does not already exist for it. Bug
|
|
|
|
|
reports should state expected behavior and contain clear instructions for
|
|
|
|
|
isolating and reproducing the problem.
|
2015-11-24 14:09:35 -05:00
|
|
|
See [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
|
2015-05-22 12:08:24 -05:00
|
|
|
|
2015-12-17 10:37:16 -05:00
|
|
|
|
2015-05-22 12:08:24 -05:00
|
|
|
#### New features
|
|
|
|
|
|
2015-11-24 14:09:35 -05:00
|
|
|
Before submitting a pull request, please open an issue first to discuss it and
|
|
|
|
|
claim it. This prevents overlapping efforts and keeps the project in-line with
|
|
|
|
|
its goals. If you prefer to discuss the feature privately, you can reach other
|
2015-12-17 10:37:16 -05:00
|
|
|
developers on Gitter or you may email me directly. (My email address is below.)
|
2015-05-22 12:08:24 -05:00
|
|
|
|
|
|
|
|
And don't forget to write tests for new features!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Vulnerabilities
|
2015-04-27 11:41:55 -05:00
|
|
|
|
2015-11-24 14:09:35 -05:00
|
|
|
If you've found a vulnerability that is serious, please email me: Matthew dot
|
|
|
|
|
Holt at Gmail. If it's not a big deal, a pull request will probably be faster.
|
2015-04-27 11:41:55 -05:00
|
|
|
|
2015-05-22 12:08:24 -05:00
|
|
|
|
|
|
|
|
## Thank you
|
|
|
|
|
|
2015-11-24 14:09:35 -05:00
|
|
|
Thanks for your help! Caddy would not be what it is today without your contributions.
|
