EPIC Review documentation for best practices
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
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Start with the Scope and the CMS 4/CMS 5 applicability decision. The issue names no files or tests; completion would require an agreed documentation review scope and applying the listed best-practice criteria while leaving the explicitly out-of-scope items untouched.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Scope
The primary purpose of this PR is to ensure that:
- code examples exhibit best practices, including but not limited to:
- always using namespaces, with exception of
PageandPageController - always using
::create()instead ofnewfor instantiatingInjectableclasses - would pass linting
- always using namespaces, with exception of
- code examples are consistent
- written documentation encourages best practice, especially when documenting alternatives that should be only used if they're specifically needed to be done that way
- written documentation is clear and understandable
- written documentation always uses an API link the first time a class, method, or property is referenced on that page
- method names referenced in written documentation end with
()
Explicitly out of scope
- grammatical or spelling mistakes in existing writing
- inconsistent markdown styling
- anything else that will be covered by https://github.com/silverstripe/developer-docs/issues/11
Decisions to be made:
- Does this only apply to CMS 5 doc (like #212 did) or to CMS 4 AND 5 docs?
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 7
- Forks
- 76
- Merge medio
- 1 d 12 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una 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 silverstripe/developer-docs
-
6.0.0 changelog: DBField formatters on array getters now render emptyPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
silverstripe/developer-docs#912 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rulesAbiertoaffects/v6 complexity/low impact/low type/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
silverstripe/developer-docs#909 · 1 comentario ·
-
affects/v6 complexity/low impact/low type/docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
silverstripe/developer-docs#908 · 1 comentario ·
-
affects/v5 affects/v6 complexity/low impact/low type/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
silverstripe/developer-docs#907 · 1 comentario ·
Todos los issues de silverstripe/developer-docs
Issues similares
-
waiting-for-triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
spring-cloud/spring-cloud-openfeign#1443 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
RedHatQE/mtv-api-tests#721 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 84/100
ADORSYS-GIS/keycloak-oid4vp-plugin#221 ·
Los mantenedores suelen responder en 2 días
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 83/100
Los mantenedores suelen responder en 3 días