0
Fork 0
mirror of https://github.com/willnorris/imageproxy.git synced 2024-12-16 21:56:43 -05:00

add contributing docs for reporting issues

This commit is contained in:
Will Norris 2019-06-10 00:41:05 +00:00
parent be4555a867
commit 66cc052997

View file

@ -8,6 +8,19 @@ bug being fixed.
For new functionality, it's general best to open an issue first to discuss it. For new functionality, it's general best to open an issue first to discuss it.
## Reporting issues
Bugs, feature requests, and development-related questions should be directed to
the [GitHub issue tracker](https://github.com/willnorris/imageproxy/issues).
If reporting a bug, please try and provide as much context as possible such as
what version of imageproxy you're running, what configuration options, specific
remote URLs that exhibit issues, and anything else that might be relevant to
the bug. For feature requests, please explain what you're trying to do, and
how the requested feature would help you do that.
Security related bugs can either be reported in the issue tracker, or if they
are more sensitive, emailed to <will@willnorris.com>.
## Code Style and Tests ## Code Style and Tests
Go code should follow general best practices, such as using go fmt, go lint, and Go code should follow general best practices, such as using go fmt, go lint, and