Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Cerrado
  • ¿Algo no está bien?
#1,889 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Empieza leyendo CONTRIBUTING.md y compáralo después con docs/contributing.rst, AI_POLICY.md y .audit/AI_AUDIT_PROCESS.md. Verifica los just recipes actuales, el src-layout test path, los install extras y el docs command antes de actualizar las guías. La tarea estará terminada cuando ambas guías de contribución documenten las reglas de issue-first, AI-disclosure y ramas, y ya no hagan referencia a comandos o rutas obsoletos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
2.5k
Forks
767
Merge medio
23 h 55 min
PR fusionados (30 d)
25

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de crossbario/autobahn-python

Todos los issues de crossbario/autobahn-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.