Contributing

If you find issues, report them on GitHub.

If you would like to contribute to the code, the process is pretty simple:

Familiarise yourself with this package, java-ngrok's APIs and other documentation, and ngrok's documentation.
Fork the repository on GitHub and start implementing changes.
Write a test that plainly validates the changes made.
Build and test locally with make local and make test.
Ensure no linting errors were introduced by running make check.
Submit a pull requests to get the changes merged.

Also be sure to review the Code of Conduct before submitting issues or pull requests.

Want to contribute financially? If you've found java-ngrok useful, sponsorship would also be greatly appreciated!