Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (19 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.49 KB

Contributing to TLSPROXY

First off, thank you for considering contributing to TLSPROXY! It's people like you that make TLSPROXY such a great tool.

How to Contribute

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into TLSPROXY itself.

Reporting Bugs

If you find a bug, please open an issue on our GitHub Issues page. Please include as much detail as possible, including your configuration, what you expected to happen, and what actually happened.

Suggesting Enhancements

If you have an idea for a new feature or an enhancement to an existing one, please open an issue on our GitHub Issues page. This allows for a discussion of the proposed feature.

Pull Requests

We welcome pull requests. If you'd like to contribute code, please:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Run go generate ./... to update any generated files.
  5. Add or update tests for your changes. Make sure all tests pass.
  6. Ensure your code follows the project's existing style.
  7. Submit a pull request with a clear description of your changes.

License

By contributing to TLSPROXY, you agree that your contributions will be licensed under the MIT License. A copy of the license can be found in the LICENSE file.