Welcome! We are very happy that you're reading this!
Your feedback and your experience are important for the project :)
If you'd like to suggest a feature, feel free to submit an issue and:
- Write a simple and descriptive title to identify your suggestion.
- Provide as many details as possible, explain your context and how the feature should work.
- Explain why this improvement would be useful.
- Keep the scope narrow. This will make it easier to implement.
Report bugs for pytest-recording in the issue tracker.
If you are reporting a bug, please:
- Write a simple and descriptive title to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include Python / pytest-recording versions.
It would be awesome if you can submit a failing test that demonstrates the problem.
Fork the repository.
Enable and install pre-commit to ensure style-guides and code checks are followed.
Target the
masterbranch.Follow PEP-8 for naming and ruff for formatting.
Tests are run using
tox:tox -e py37
The test environments above are usually enough to cover most cases locally.
Write an entry to changelog.rst
Format your commit message according to the Conventional Commits specification
If you have troubles with installing pycurl with tox, you could try to pass CPPFLAGS and LDFLAGS
with the tox command:
$ CPPFLAGS="-I/usr/local/opt/openssl/include" LDFLAGS="-L/usr/local/opt/openssl/lib" tox -p allFor each pull request, we aim to review it as soon as possible. If you wait a few days without a reply, please feel free to ping the thread by adding a new comment.
At present the core developers are:
- Dmitry Dygalo (@Stranger6667)
Thanks!