Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (34 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.29 KB

Contributing to Codex SEO

Thanks for contributing.

Ground Rules

  • Keep changes focused and minimal.
  • Preserve project lineage and attribution to the upstream project.
  • Do not remove legal/disclosure language without maintainer approval.
  • Use clear commit messages.

Local Setup

gh repo clone AgriciDaniel/codex-seo
cd codex-seo
python -m pip install -r requirements.txt

If you are working from a public fork, a normal git clone of that fork is fine. Keep credentials, .env files, .mcp.json, output/, and .seo-cache/ out of commits.

Validation Before PR

Run the same baseline checks used by CI:

bash -n install.sh
bash -n uninstall.sh
bash -n hooks/pre-commit-seo-check.sh
python -m pytest tests/
python -m compileall -q scripts hooks

Pull Request Checklist

  • Explain the problem and the fix.
  • Note any behavior changes.
  • Update docs when commands or workflows change.
  • Avoid unrelated refactors.

Code Style

  • Python: follow PEP 8 conventions. If you have Ruff installed, run ruff check . before submitting.
  • Shell scripts: use shellcheck where possible.
  • Keep formatting consistent with surrounding code.

Security Fixes

For vulnerabilities, follow SECURITY.md instead of opening a detailed public issue.