💻 Contributing to pastebin-bisque 💻#
👋 Hello, world. Contributions to pastebin-bisque are very welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
🐛 Bug Reports#
When reporting a bug please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
📚 Documentation Improvements#
Documentation updates are welcome. That includes docstrings and links to blog posts or articles. Open an issue to start discussing your ideas.
💡 Feature Requests and Feedback#
The best way to send feedback is to file an issue.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that code contributions are welcome :)
To set up pastebin-bisque for local development:
Fork pastebin-bisque (look for the “Fork” button).
Clone your fork locally
Set up the development tools with one of these commands:
pip install bump2version check-manifest docutils isort pre-commit pygments readme-renderer python -I -m pip install check-manifest docutils isort pre-commit pygments readme-renderer
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
To do a quick test of your changes:
python setup.py install rm $(which pastebin-bisque) && python setup.py install # subsequent runs
When you’re done making changes run all the checks and docs builder with one command:
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pushing a new patch version:
pre-commit run --all-files && \ git commit -am"✨ Add it all" && \ bump2version patch && \ git push --tags
ℹ️ Pull Request Guidelines#
If you need some code review or feedback while you’re developing the code just make the pull request and ask Brie to take a look.
To make it easier for your work to be reviewed and merged, you should:
Make sure that tests are passing (run
Update documentation as appropriate.
Add a note to
CHANGELOG.rstdescribing the changes.
Add yourself to
Don’t let the perfect be the enemy of the good. Go ahead and git commit and git push so we can 🤝 get started.
To run a subset of tests:
tox -e envname -- pytest -k test_myfeature
To run all the test environments in parallel:
tox -p auto
For quick development:
rm $(which pastebin-bisque) && python setup.py install && pastebin-bisque
Installing the current version from TestPyPI:
pip install -i https://test.pypi.org/simple/ pastebin-bisque==$(grep ^current_version .bumpversion.cfg | cut -d"=" -f2 | cut -d" " -f2) --extra-index-url https://pypi.org/simple
The –extra-index-url https://pypi.org/simple is important because the dependencies on TestPyPI are out-of-date or not present.