Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[CHORE] Refresh CONTRIBUTING.md: document issue-first + AI-disclosure (.audit) requirements; fix stale tox/paths

Aperta
  • Qualcosa non va?
#1,889 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia leggendo CONTRIBUTING.md, poi confrontalo con docs/contributing.rst, AI_POLICY.md e .audit/AI_AUDIT_PROCESS.md. Verifica i just recipes attuali, il src-layout test path, gli install extras e il docs command prima di aggiornare le guide. Il lavoro è completato quando entrambe le guide per i contributi documentano le regole issue-first, AI-disclosure e dei branch e non fanno più riferimento a comandi o percorsi obsoleti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug CI-CD docs

Why

CONTRIBUTING.md is both incomplete (it omits requirements we actually
enforce) and stale (it references tooling/paths we no longer use). PR #1887
is a good example: the contributor followed the public guide, but tripped over
process rules that are only written down in AI_POLICY.md / .ai /
.audit/AI_AUDIT_PROCESS.md, not in CONTRIBUTING.md. Let's make the public
guide match reality so external contributors can succeed first time.

Missing — add these

  • Issue-first workflow. State that every change starts from a GitHub
    issue, and the PR must reference it (Closes #<issue>). The current
    "Contributing Code" list jumps straight to fork/branch.
  • AI-assistance disclosure. Document that every PR must include a
    disclosure file at .audit/<github-username>_<branch>.md (e.g.
    .audit/bblommers_websocket-server-typing.md), not a PR comment. Link
    .audit/AI_AUDIT_PROCESS.md
    and AI_POLICY.md. (This is the biggest gap — currently undocumented.)
  • Branch guidance. Note the fix_<issue> convention for maintainers,
    while making clear descriptive branch names from external forks are welcome
    (e.g. patch-1).

Stale — fix these

  • Test runner. Replace the tox / tox -e py312 section with the
    current just recipes (just test, just check, etc.).
  • Test path. pytest autobahn/test/test_websocket.py → src-layout
    src/autobahn/test/....
  • Install & docs. Re-check pip install -e .[dev,twisted,asyncio] and
    cd docs && make html against the current extras ([all]/[dev]) and the
    just docs recipe.

Notes

  • Pure documentation; no code/behaviour change.
  • Keep CONTRIBUTING.md aligned with docs/contributing.rst if both are shipped.

This analysis was produced with AI assistance (Claude Code) and requires human review before filing. Which I did.

Checklist

  • I have searched existing issues to avoid duplicates
  • I have provided a minimal reproducible example
  • I have included version information
  • I have included error messages/logs
Lingua principale
Python
Stelle
2.5k
Fork
770
Merge medio
2g 6h
PR unite (30g)
10

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di crossbario/autobahn-python

Tutte le issue di crossbario/autobahn-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.