Thank you for your interest in contributing to Reflex!
This guide provides information on how you can get started contributing to Reflex, whether that's by reporting a bug, requesting a feature, or submitting a PR to resolve an existing issue.
These guidelines are provided to make the process of contributing to Reflex an easy and enjoyable experience, for both you and the maintainers. We appreciate you taking the time to read and adhere to these guidelines before contributing.
Always treat others in a kind, respectful manner. If you need more detailed guidance, refer to the Python Community Code of Conduct.
- Create your own fork of the code
- Do the changes in your fork
- If you like the change and think the project could use it:
- Be sure you have followed the code style for the project. (We format our code with black.)
- Create a pull request and link any associated issues.
If you find a security vulnerability, do NOT open an issue. Email info@reflexivesecurity.com instead.
If you've found a bug that isn't a security vulnerability, please open an issue in the relevant repository.
When filing an issue, make sure to address these five points:
- What version of Python are you using? (python --version)
- What operating system are you using?
- Steps to reproduce.
- What did you expect to see?
- What did you see instead?
If you you have a desire for a new feature, open an issue on the pertinent GitHub repo which describes the feature you would like to see, why you need it, and how it should work.