We love your input! We want to make contributing to TokenShield 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
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow
Pull requests are the best way to propose changes to the codebase:
- Fork the repo and create your branch from
main - If you've added code that should be tested, add tests
- If you've changed APIs, update the documentation
- Ensure the test suite passes
- Make sure your code follows the existing style
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening)
- Python: Follow PEP 8
- Use meaningful variable names
- Comment complex logic
- Keep functions focused and small
- Add tests for new features
- Ensure all tests pass before submitting PR
- Test with the dummy app and gateway
By contributing, you agree that your contributions will be licensed under its MIT License.