Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.55 KB
Raw

Contributing to PyEzTrace

We love your input! We want to make contributing to PyEzTrace as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

Pull requests are welcome!

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

To exercise the OpenTelemetry bridge tests locally, install the optional dependencies with:

pip install "pyeztrace[otel]"

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issue tracker

Report a bug by opening a new issue on Github.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

By contributing, you agree that your contributions will be licensed under its MIT License.