RFC: New repository for code examples in Documentation
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
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
El issue no menciona archivos, pruebas ni puntos de entrada; empieza revisando la documentación existente y sus fragmentos de código. Se considerará terminado cuando se cree un repositorio separado con ejemplos ejecutables para las clases principales y se añadan referencias directas a esos ejemplos desde la documentación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Most of the documents bring code snippets. Considering that full file examples would take a lot of space in the documents and make them complex, a new repository with running examples per main classes would be a useful complement to them. The documentation could make direct reference to them. The users can clone the repository and run the examples in his/her local environment to have fully running demos of the code cited in the docs.
- Lenguaje dominante
- MDX
- Estrellas
- 23
- Forks
- 29
- Merge medio
- 28 min
- PR fusionados (30 d)
- 3
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 phalcon/documentation
-
Document DataMapper\ORMQuizá libre de nuevo @niden la tomó hace 596 días y no hay ningún pull request abierto. Abiertodocumentation enhancement
phalcon/documentation#247 · 1 asignado ·
-
Document DataMapper\MapperQuizá libre de nuevo @niden la tomó hace 596 días y no hay ningún pull request abierto. Abiertodocumentation enhancement
phalcon/documentation#246 · 1 asignado ·
-
Document DataMapper\CliQuizá libre de nuevo @niden la tomó hace 596 días y no hay ningún pull request abierto. Abiertodocumentation enhancement
phalcon/documentation#245 · 1 asignado ·
-
Document DataMapper\InfoQuizá libre de nuevo @niden la tomó hace 596 días y no hay ningún pull request abierto. Abiertodocumentation enhancement
phalcon/documentation#244 · 1 asignado ·
-
Document DataMapper\TableQuizá libre de nuevo @niden la tomó hace 596 días y no hay ningún pull request abierto. Abiertodocumentation enhancement
phalcon/documentation#243 · 1 asignado ·
Todos los issues de phalcon/documentation
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 90/100
components-web-app/docs#142 ·
-
thread safetyAbierto1.0
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
embed: handleTurboSignMessage header comment says the signing page posts to '*' (it never does)Abiertodocumentation
Dificultad 2/5 Menos de una hora Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
Erreur dans le documentationAbiertobug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
stephrobert/pavois#390 ·
Los mantenedores suelen responder en 1 día