Skip to content

docs: add CONTRIBUTING guide and local setup instructions - #385

Open
oscarbol09 wants to merge 2 commits into
BrunoSobrino:masterfrom
oscarbol09:docs/contributing-guide
Open

docs: add CONTRIBUTING guide and local setup instructions#385
oscarbol09 wants to merge 2 commits into
BrunoSobrino:masterfrom
oscarbol09:docs/contributing-guide

Conversation

@oscarbol09

Copy link
Copy Markdown

Fixes #368

Cambios

CONTRIBUTING.md (nuevo)

Guia de contribucion completa para nuevos colaboradores:

  • Estado actual del proyecto (DEPRECATED, mantenido por colaboradores) y expectativas
  • Como reportar bugs (label Bug) y solicitar caracteristicas (label Enhancement)
  • Flujo completo de PR: fork, remoto upstream, convencion de ramas (fix/, feature/, docs/, refactor/)
  • Convencion de commits convencionales con ejemplos
  • Estructura del proyecto (plugins/, src/, lib/, config.js)
  • Como crear un plugin correctamente, con la advertencia clave: \handler.command\ es obligatorio (el dispatcher en handler.js no usa \handler.help\ como fallback β€” causa del issue Problema en el playΒ #370)
  • Checklist final para la PR

README.md

  • Nueva seccion 'Instalacion y Ejecucion Local' (lo que pedia el issue Solicitud de mejora en la documentaciΓ³nΒ #368): requisitos (Node 18+, ffmpeg), pasos de clonado/instalacion/configuracion (config.js, no .env), tabla de comandos de conexion (
    pm start\ /
    pm run qr\ /
    pm run code) y verificacion con .menu\
  • Nueva seccion 'Contribuir' con enlace al CONTRIBUTING.md
  • TOC actualizado

Verificacion

  • Documentacion basada en datos reales del repo: scripts de package.json, config.js, estructura de plugins y handler.js
  • Commits convencionales: \docs: add CONTRIBUTING guide\ y \docs: add local setup instructions to README (fixes Solicitud de mejora en la documentaciΓ³nΒ #368)\

Notas

  • \src/docs/README_en.md\ y \README_pt-br.md\ estan vacios (0 bytes) en master; las traducciones quedan como trabajo futuro

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Solicitud de mejora en la documentaciΓ³n

1 participant