2.9 KiB
Contributing to Caddy
Welcome! Our community focuses on helping others and making Caddy the best it
can be. We gladly accept contributions and encourage you to get involved!
Join us in chat
Please direct your discussion to the correct room:
- Dev Chat: gitter.im/mholt/caddy - to chat
with other Caddy developers - Support:
gitter.im/caddyserver/support - to give
and get help - General:
gitter.im/caddyserver/general - for
anything about Web development
Bug reports
First, please search this repository
with a variety of keywords to ensure your bug is not already reported.
If not, open an issue and answer the
questions so we can understand and reproduce the problematic behavior.
The burden is on you to convince us that it is actually a bug in Caddy. This is
easiest to do when you write clear, concise instructions so we can reproduce
the behavior (even if it seems obvious). The more detailed and specific you are,
the faster we will be able to help you. Check out
How to Report Bugs Effectively.
Please be kind. 😄 Remember that Caddy comes at no cost to you, and you're
getting free help. If we helped you, please consider
donating - it keeps us motivated!
Minor improvements and new tests
Submit pull requests at any time. Make
sure to write tests to assert your change is working properly and is thoroughly
covered.
Proposals, suggestions, ideas, new features
First, please search
with a variety of keywords to ensure your suggestion/proposal is new.
If so, you may open either an issue or a pull request for discussion and
feedback.
The advantage of issues is that you don't have to spend time actually
implementing your idea, but you should still describe it thoroughly. The
advantage of a pull request is that we can immediately see the impact the change
will have on the project, what the code will look like, and how to improve it.
The disadvantage of pull requests is that they are unlikely to get accepted
without significant changes, or it may be rejected entirely. Don't worry, that
won't happen without an open discussion first.
If you are going to spend significant time implementing code for a pull request,
best to open an issue first and "claim" it and get feedback before you invest
a lot of time.
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.
Thank you
Thanks for your help! Caddy would not be what it is today without your
contributions.