Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.78 KB

Contributing to BPD Streamlit booth slider

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.

Code of Conduct

Help us keep this project open and inclusive. Please read and follow our Code of Conduct.

How Can I Contribute?

Ready to contribute? Here's how to set up streamlit-booth-slider for local development.

  1. Fork the streamlit-booth-slider repo on GitHub.
  2. Clone your fork locally
    $ git clone [email protected]:your_name_here/streamlit-booth-slider.git
  1. 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

  1. 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.

  1. 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.

  1. 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
  1. Submit a pull request.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. Ensure that everything is running.
  2. If the pull request adds functionality, the comments should be updated.