Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (42 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 1.57 KB

Contributing to PCHA Dashboard

Thank you for your interest in contributing to the PCHA Dashboard, a PyShiny-based accessible health data visualization tool.

How to Contribute

1. Fork and Clone

git clone https://github.com/xability/pcha-health-dashboard.git
cd Dashboard

2. Set Up Environment

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

3. Run the App Locally

shiny run --reload app.py

Guidelines

  • Follow PEP8 and Python best practices
  • Use maidr for all key data visualizations to ensure accessibility
  • Clearly label all charts and filters
  • Use semantic HTML where applicable for screen reader compatibility

Accessibility Standards

We aim to provide full access to users who are blind or have low vision. Please:

  • Ensure graphs are compatible with maidr
  • Include alt-text or captions where possible
  • Avoid relying solely on visual cues (e.g., color-only distinctions)

Deployment

Deployment is handled through shinyapps.io

  1. Ensure the app runs correctly locally
  2. Deploy using rsconnect with Python support or push updates to the hosting environment

Note: The free version of Shiny only supports up to 5 deployments, because of which the workflow might fail

Reporting Issues

If you find a bug or have a feature request, open an issue at:
https://github.com/xabilitylab/pcha-dashboard/issues

Thank you for helping make this dashboard better and more inclusive.