If you discover a security vulnerability, please review our Security Policy, then report the issue directly to us from waterhole.dev/support. We will review and respond privately via email. All security vulnerabilities will be promptly addressed.
Warning: Waterhole's GitHub issue trackers are not intended to provide help or support. Instead, get support from the community, or from waterhole.dev/support if you have an active license.
Found a bug? Great! We'd love to hear about it – but first you should search through the community and issue tracker to make sure you're not wasting your time on a known issue.
If you do find a similar issue, upvote it by adding a 👍 reaction. Only leave a comment if you have relevant information to add.
If no one has filed the issue yet, feel free to submit a new one. Please include a clear description of the issue, and as much relevant information as possible.
Remember: the goal of a bug report is to make it easy for us to replicate the bug and fix it. You might want to read this article for some useful tips on how to write an effective bug report. It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear reproduction steps will not be triaged.
We welcome pull requests to the waterholeforum/core repository. Pull requests should clearly describe the problem and solution. Include the relevant issue number if there is one. If the pull request fixes a bug, it should include a new test case that demonstrates the issue, if possible.
Do not commit any changes to compiled files, like those found in resources/dist. Due to their large size, they cannot realistically be reviewed. To defend against possible injection of malicious code, all compiled files will be generated and committed by the core Waterhole team.
If you would like to work on a new feature, consider discussing it first in the Ideas channel before you spend time on it. While we appreciate community contributions, we are quite selective about what features make it into Waterhole itself, so don't take it the wrong way if we suggest that you pursue the idea as an extension instead.