First, thank you for taking time to contribute to open source and to this project! Here's how contributing to this project works.
- Fork the repo and create your own branch from
main. The branch should be named after the type of issue your are solving.
feat/[summary-with-dashes] (this one covers anything you can't fit in the other categories)
fix/[summary-with-dashes]
docs/[summary-with-dashes]
- Setup your local development environment. Texutal Inputs currently supports CPython 3.7 - 3.10. Please test your additions with at least the Python versions at the ends of that range.
bash/zsh/sh
python3.7 -m venv venv7
source venv7/bin/activate
python -m pip install -r requirements-dev.txt
python -m pip install -e .
deactivate
python3.10 -m venv venv10
source venv10/bin/activate
python -m pip install -r requirements-dev.txt
python -m pip install -e .
pre-commit installpwsh
py -3.7 -m venv venv7
venv10/Scripts/activate
python -m pip install -r requirements-dev.txt
python -m pip install -e .
deactivate
py -3.10 -m venv venv10
venv7/Scripts/activate
python -m pip install -r requirements-dev.txt
python -m pip install -e .
pre-commit install- Make your updates, including updating the documentation if necessary.
- Ensure your code passes our linting and formatting checks. This project uses pre-commit to help manage code quality. It will run on
git commit. You can also run it manually.
pre-commit run -a- Start your commit message with a similar format to the branch.
# Branch
feat/add-integer-widget
# Commit
feat: add integer widget
- list of changes
- contained in this commit
- Create a pull request and add
sirfuzzalotas the reviewer. - We'll got through a review of the code, work through any challenges we hit and then merge it in.
Version bumps will occur as separate pull requests and releases will get tagged on those commits. Please do not submit a version bump PR. Thanks!
All contributions you make to this project will be licensed under the MIT License.