Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (47 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 2.28 KB
Raw

Contributing Guide

Thanks for considering contributing to Wildfire Burn Severity Analysis App!
All kinds of contributions are welcome (✨ adding features, 🐛 bug fix and reports, 🎨 design, 📝 documentation, fixing typos ...etc).

Baby Yoda reminds you:
"⭐ Star the repo, you must!". (in giberish of course but we just guess that's what he says... )

🗂️ How to Contribute

  1. Check existing issues

  2. Get assigned

    • If you want to work on an issue, ask the maintainer to assign you before you start.

  3. Fork & Sync

    • Fork the repository.
    • Keep your fork in sync with streamlit-dev to avoid conflicts.

🌱 Development Workflow

This project uses git-flow:

  • streamlit-main → production branch
  • streamlit-dev → active development branch
  • feature/name → new feature branches (PR against streamlit-dev)
  • release/vX.Y.Z → release preparation branches
  • hotfix/vX.Y.Z → emergency fixes

👉 Always create your branch off streamlit-dev.

🔀 Pull Requests

  • Open your PR against streamlit-dev, not streamlit-main.
  • Use a clear, descriptive title.
  • Link related issue(s) in the PR description.
  • Provide screenshots, GIFs, or videos for UI/visual changes.
  • Document your code, document your code, document your code.
  • Ensure your changes don’t break existing features.

🏷️ Issues

  • Issues are labeled to help contributors and maintainers prioritize.
  • Before starting work, request to be assigned to the issue.

✅ Checklist Before Submitting

  • My code follows the style guidelines of this project.
  • I ran the app locally to verify my changes.
  • I documented new/modified functionality.
  • I based my branch on streamlit-dev.

🙌 Final Note

Don’t hesitate to ask questions or propose improvements.

And remember:

Follow Baby Yoda’s rules at all times.