Skip to content

Latest commit

 

History

History
50 lines (44 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

50 lines (44 loc) · 1.01 KB

Contributing to Streamlit-Analytics2

Getting Started

  1. Fork and clone:
git clone https://github.com/444B/streamlit-analytics2.git
cd streamlit-analytics2
  1. Create branch:
git checkout -b test/your-feature-name

Development Environment Setup

  1. Install Python 3.10.x
  2. Install and setup uv:
pip install uv
uv venv .venv --python 3.10.16
source .venv/bin/activate
  1. Install dependencies:
uv pip install -e ".[dev]"
  1. Verify setup:
streamlit run examples/minimal.py

Quality Checks

cd tests/
chmod +x run_checks.sh
./run_checks.sh
./run_checks.sh --fix # this will implement the fixes

Pull Request Process

  1. Push changes:
git add .
git commit -m "Your commit message"
git push origin test/your-feature-name
  1. Open PR on GitHub

For issues: GitHub issue tracker

By contributing, you agree to the project's license.