Create a style guide page for plugin developers
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 32/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Empieza con la guía existente “Contributing to Piwik core” enlazada en el issue e identifica las directrices de estilo que se deben extraer. Crea una guía de estilo independiente para desarrolladores de plugins que cubra los temas de nomenclatura y arquitectura indicados, y enlázala desde la categoría “Develop => Getting started”.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
- Should include naming for common db fields like
created_date,updated_dateto have this consistent (also reflects later in API calls etc) - Common naming for DB tables (eg singular vs plural)
- Explain
DaovsModelsetc.
As it is a lot of work to create such a document I suggest we simply start with a few styles and tweak it over time. Some parts are already defined here: https://developer.piwik.org/guides/contributing-to-piwik-core we would need to extract some of this stuff and put it into a separate document as contributing to Piwik core page is way too long.
Then we can also link to that page from the "Develop => Getting started" category.
Any thoughts @mattab @sgiehl ?
- Lenguaje dominante
- PHP
- Estrellas
- 58
- Forks
- 88
- Merge medio
- 6 h 29 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 matomo-org/developer-documentation
-
Documentation enhancement
Dificultad 1/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 55/100
matomo-org/developer-documentation#806 · 2 comentarios ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
matomo-org/developer-documentation#787 · 1 comentario ·
Todos los issues de matomo-org/developer-documentation
Issues similares
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 2 días
-
UX
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
ProfessionalWiki/NeoWiki#1573 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100