How/where/what to document
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
No se identifican archivos, pruebas ni puntos de entrada específicos. Revisa primero el README existente y la estructura de la documentación; después, define una guía de contribución que cubra dónde deben ubicarse los permisos, las rutas, los flujos de usuario y la información para comenzar.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I have always felt that there should be more of a process/guidelines when it comes to documenting stuff. I imagine there is a lot overlap with what you want to be documented across projects (permissions/routes/user-flows/getting-started/...).
It would help to have a specific guide to follow so that I know where to add this piece of information rather than just stick it on the end of a potentially long readme.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 92
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de dwyl/contributing
-
bug chore starter
Dificultad 1/5 Menos de una hora Aptitud para principiantes 38/100
dwyl/contributing#119 · 1 reacción ·
-
'Why? What? Who? How?' formatAbiertoenhancement starter
Dificultad 1/5 1-3 horas Aptitud para principiantes 35/100
dwyl/contributing#118 · 1 reacción ·
-
How to do a code reviewAbiertodiscuss enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
dwyl/contributing#113 · 2 reacciones ·
-
discuss enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
dwyl/contributing#112 · 1 reacción ·
-
Draft Pull Requests!Abiertodiscuss enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 42/100
dwyl/contributing#111 · 2 comentarios · 3 reacciones ·
Todos los issues de dwyl/contributing
Issues similares
-
desktop documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
vfarcic/dot-agent-deck#2008 ·
Los mantenedores suelen responder en 1 día
-
docs: Google Safe Browsing flags go-bonnie.dev as "deceptive" (pipe-to-shell install instructions)Abiertodocumentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 2 días
-
difficulty:2 enhancement good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
MakazhanAlpamys/Soup#2309 ·
Los mantenedores suelen responder en 1 día
-
[Integration]: eRPCAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
ava-labs/builders-hub#4826 ·
Los mantenedores suelen responder en 1 día