First off, thank you for considering contributing to BPD booth slider. It's people like you that make Black Python Devs such a great community.
Help us keep this project open and inclusive. Please read and follow our Code of Conduct.
Ready to contribute? Here's how to set up streamlit-booth-slider
for local development.
- Fork the
streamlit-booth-slider
repo on GitHub. - Clone your fork locally
$ git clone [email protected]:your_name_here/streamlit-booth-slider.git
- Install a virtual environment of your choice and more into the working directory the install requirements
$ cd streamlit-booth-slider
$ pip install -r requirements.txt
Run streamlit run app.py
ensure that it is running fine
- Create a branch for local development, idealy must explain the issue you want to work on
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
- When you're done making changes, check that your changes are working by running streamlit locally and test
$ streamlit run app.py
Ensure that everything is working on the browser. Test everything end to end to ensure that everything is working.
- 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.
Before you submit a pull request, check that it meets these guidelines:
- Ensure that everything is running.
- If the pull request adds functionality, the comments should be updated.