Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.12 KB

Contributing 🤝

Thanks for contributing to X Archive Explorer.

📌 Ground Rules

  • Keep changes focused and production-ready.
  • Preserve existing behavior unless the change explicitly modifies it.
  • Add tests for new behavior and bug fixes whenever possible.
  • Keep documentation aligned with code changes.

🛠️ Local Setup

  1. Create and activate a virtual environment (Python 3.12+):
python --version
python -m venv .venv
source .venv/bin/activate

On Windows (PowerShell), activate with:

.venv\Scripts\Activate.ps1
  1. Install dependencies:
pip install -r requirements.txt
pip install -r requirements-dev.txt
  1. Apply migrations:
flask --app run.py db upgrade
  1. Run tests:
python -m pytest -q

✅ Pull Request Checklist

  • Clear title and scope.
  • Reproducible steps for bug fixes.
  • Tests added or updated.
  • No secrets or local files committed.
  • README updated when behavior changes.

🧩 Code Style

  • Follow existing project style and naming.
  • Prefer small, readable functions.
  • Keep user-facing text consistent with i18n strategy.