github-mirror/caddy
2
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2024-11-29 12:16:16 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

wrap lines to 80 characters

Browse Source 
also linked to bug reporting article.
This commit is contained in:
jungle-boogie 2015-11-24 11:09:35 -08:00
parent bc37cf0d1c
commit a60c739797
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -1,32 +1,44 @@
## Contributing to Caddy ## Contributing to Caddy
**[Join us on Slack](https://gophers.slack.com/messages/caddy/)** to chat with other Caddy developers! ([Request an invite](http://bit.ly/go-slack-signup), then join the #caddy channel.) **[Join us on Slack](https://gophers.slack.com/messages/caddy/)** to chat with
other Caddy developers! ([Request an invite](http://bit.ly/go-slack-signup),
then join the #caddy channel.)
This project gladly accepts contributions and we encourage interested users to get involved! This project gladly accepts contributions and we encourage interested users to
get involved!
#### For small tweaks, bug fixes, and tests #### For small tweaks, bug fixes, and tests
Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time. Thank you for helping out in simple ways! Bug fixes should be under test to assert correct behavior. Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time.
Thank you for helping out in simple ways! Bug fixes should be under test to
assert correct behavior.
#### Ideas, questions, bug reports #### Ideas, questions, bug reports
You should totally [open an issue](https://github.com/mholt/caddy/issues) with your ideas, questions, and bug reports, if one does not already exist for it. Bug reports should state expected behavior and contain clear instructions for reproducing the problem. You should totally [open an issue](https://github.com/mholt/caddy/issues) with
your ideas, questions, and bug reports, if one does not already exist for it.
Bug reports should state expected behavior and contain clear instructions for
reproducing the problem.
See [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
#### New features #### New features
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 developers on Slack or you may email me directly. (My email address is below.) 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
developers on Slack or you may email me directly. (My email address is below.)
And don't forget to write tests for new features! And don't forget to write tests for new features!
#### Vulnerabilities #### Vulnerabilities
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. 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.
## Thank you ## Thank you
Thanks for your help! Caddy would not be what it is today without your contributions. Thanks for your help! Caddy would not be what it is today without your contributions.