Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.11 KB

CONTRIBUTING.rst

File metadata and controls

19 lines (14 loc) · 1.11 KB

Contributing

If you find issues, report them on GitHub.

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

  1. Familiarise yourself with this package, pyngrok's APIs and other documentation, and ngrok's documentation.
  2. Fork the repository on GitHub and start implementing changes.
  3. Write a test that plainly validates the changes made.
  4. Build and test locally with make local and make test.
  5. Ensure no linting errors were introduced by running make check.
  6. 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 pyngrok useful, sponsorship would also be greatly appreciated!