platanus / la-guia Goto Github PK

• Librerías típicas que usamos
• Estructura de carpetas
• Explicar que lo solemos usar en modo "widget" con webpacker
• Reglas de estilo que usamos (estas)

I couldn't find it anywhere...

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

• Cómo instalar (apt o source)
• Tips y errores comunes

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

• Cómo instalar (WSL)
• Tips y errores comunes

The idea is to add a section with the way we use dependencies like mysql, postgres, redis, etc. using docker-compose and a makefile

La línea no debiera tener más de 100 caracteres para que se lea bien en Github.

Me parece que es 70.

El link a https://github.com/conventional-changelog/conventional-changelog/blob/master/CONVENTIONS.md no funciona.

Deberíamos incluir ejemplos de buenos mensajes
Deberíamos incluir ejemplos de como manejar branch dependientes
Deberíamos incluir la diferencia entre reviewers y assignees

@blackjid nos encargamos?

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Ya tenemos una base buena para instalar brew

Falta chequear que sea compatible con el M1. Si hay algo no compatible, anotarlo. No se si como una sección o cuadros de información adicional

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

I think there two sections that talk about trello and how we use it. It would be nice to simplify that.

Deberíamos referenciar el README.md del directorio contenido en el README.md general?

Bullet, benchmark, etc

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Ver si dentro de power types o no.
Explicar bien los patrones.
Decir en qué casos no se debería usar.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

• Título
• Descripción corta
• ¿Por qué lo usamos?

La instalación la dejaría por cada sistema operativo

• Título
• Descripción corta
• ¿Por qué lo usamos?

La instalación la dejaría por cada sistema operativo

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Descripción:

Al crear un commit que toca la primera línea de cualquier archivo JS en donde el parser de eslint es babel-eslint el mono comenta lo siguiente:

Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-on
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/no-duplicate-attributes
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/no-textarea-mustache
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/no-unused-vars
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/require-component-is
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/require-v-for-key
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-bind
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-cloak
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-else-if
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-else
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-for
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-html
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-if
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-model
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/no-template-key
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-once
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-pre
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-show
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/valid-v-text
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/attribute-hyphenation
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/html-end-tags
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/html-indent
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/html-self-closing
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/max-attributes-per-line
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/mustache-interpolation-spacing
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/v-bind-style
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/v-on-style
Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error vue/no-multi-spaces

Por lo visto el problema lo genera esta línea:

Info adicional

• Pareciera ser que el mono usa el .eslintrc.json de platanus como base, aunque el proyecto incluya su propio eslintrc sin este plugin (p.ej: https://github.com/platanus/ksec/blob/d6660875d447c3722ecbe985519297e343d22f23/.eslintrc.json )
• No se puede hacer override del extends por la versión de eslint que usamos (eslint/eslint#8813)
• Estoy probando con usar "root": true en el eslint para ver si eso soluciona el problema Update: no lo soluciona

Soluciones propuestas

• Agregar configuración para soportar babel ( vuejs/eslint-plugin-vue#30 (comment) ). No me gusta porque habría que agregar la dependencia del plugin de vue a un proyecto que no tiene nada de vue
• Hacer que el mono considere sólo el .eslintrc.json especificado sin heredar del global
• Actualizar eslint^6 y usar overrides: extends... (eslint/eslint@54e6eda)
• Eliminar la linea que agrega el extends y que cada proyecto con Vue lo agregue caso a caso

• Cómo instalar (apt o source)
• Tips y errores comunes

Dada la inminente muerte de hound, creo que deberíamos actualizar la sección de linters. Cosas relevantes a considerar:

• Los linters vienen ahora en los proyectos como dependencias de development en el package.json y Gemfile, por lo que ya no es necesario la instalación global que se indica ahora. Convendrá mencionar las versiones de rubocop/rubocop-rspec igual en algún lado para proyectos antiguos?
• Para VSCode, no recuerdo haber agregado lo que sale sobre ruby.rubocop.executePath, quizás se puede borrar (?)
• Para VSCode, ahora que se usan los linters en el proyecto, por alguna razón el plugin ruby-rubocop no los detecta automáticamente si es que hay un .rubocop.yml en el root, salen errores como el siguiente:

  /Users/my_username/.rubocop.yml: Metrics/LineLength has the wrong namespace - should be Layout
  

  Para solucionarlo sin borrar el archivo del root se puede agregar lo siguiente en los settings del workspace:

  "ruby.rubocop.configFilePath": "./.rubocop.yml",
  

• No sé bien que se debería hacer con lo de typescript, en teoría también debería ir en las dependencias locales del proyecto si se necesita no?

• Cómo instalar
• Tips y errores comunes
• Ver casos borde del M1

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Installing last version of rubocop (0.47) doesn't check any files and throws the following errors:

/home/camilo/workspace/platanus/.rubocop.yml: Lint/Eval has the wrong namespace - should be Security
Error: The `Style/MethodCallParentheses` cop has been renamed to `Style/MethodCallWithoutArgsParentheses`.
(obsolete configuration found in /home/camilo/workspace/platanus/.rubocop.yml, please update it)
obsolete parameter IndentWhenRelativeTo (for Style/CaseIndentation) found in /home/camilo/workspace/platanus/.rubocop.yml
`IndentWhenRelativeTo` has been renamed to `EnforcedStyle`
obsolete parameter AlignWith (for Lint/EndAlignment) found in /home/camilo/workspace/platanus/.rubocop.yml
`AlignWith` has been renamed to `EnforcedStyleAlignWith`
obsolete parameter AlignWith (for Lint/DefEndAlignment) found in /home/camilo/workspace/platanus/.rubocop.yml
`AlignWith` has been renamed to `EnforcedStyleAlignWith`

Steps to reproduce the problem:

1. Install rubocop version 0.47: gem install rubocop -v 0.47
2. Run rubocop on any project

• Título
• Descripción corta
• ¿Por qué lo usamos?

La instalación la dejaría por cada sistema operativo

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

• Cómo instalar
• Tips y errores comunes
• Ver casos borde del M1

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Al agregar S3 a un proyecto se debe configurar CORS en el bucket para poder usarlo. Es fácil olvidarse de hacerlo y de cómo hacerlo. Podríamos tener una sección en la guía que lo explique un poco, probablemente en la sección de Setup.

También podríamos agregar un apartado explicando como agregar un bucket sin usar Bucketeer.

https://github.com/ddollar/heroku-config

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Evaluar si ponerlo dentro de la sección de Vue

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

Hola!
Entiendo que el siguiente contenido del último punto,

"Muy cargado hacia el primer punto y tu post será considerado poco académico. Demasiado cargado al segundo punto y será descartado por aburrido"

...es un párrafo independiente del listado. Debiese estar fuera del punto al cual también se refiere.

En otras palabras, entiendo que la idea es la siguiente:

• El título hace pensar al lector que ganará algo importante al leer el post.
• El títlo es realista en cuanto a lo que logrará el lector al leer el post.

Muy cargado hacia el primer punto y tu post será considerado poco académico. Demasiado cargado al segundo punto y será descartado por aburrido.

Sólo eso. Saludos con TOC. ✌🏻

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.

1. Título
   Descripción corta
2. Por qué lo usamos?
3. Cómo lo usamos? con ejemplo mínimo de uso real. Diciendo con qué versión de la herramienta se hizo el ejemplo.
4. Recursos útiles (links)
5. Sub secciones opcionales. Tips, casos típicos, etc. Lo que sea necesario tratando de que no sea fácilmente deprecated.