Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
The purpose of this package is to use PtPython as default Django shell. If you would like to participate, the following should be considered in your pull requests:
-
Add a new feature
-
Fix bugs for existing functions
-
Improve documentation
-
Is tested (see the tests directory; we use
unittest
anddjango.test
)
All code must follow the styles dictated by black.
Also, please discuss any changes in the issues before working on a PR to make sure that I'll accept it before you spend time working on it.
- Fork the repo
- Clone your fork
- Create a branch
- Run
pip install django-ptpython
- Run
python -m unittest discover
. If everything works, then you're ready to make changes. - Make your changes and try to make the tests pass. If you can't or need help then commit what you have and make a PR, we will solve it together!
- If you get things working, add your changed files with
git add
and rungit commit -m 'commit_message'
- Push your changes to your fork with
git push
- Create a pull request
- Iterate on the solution
- Get merged! 🎉