Documentar estándares de codificación esperados

[Scot3004]

Incidente sitio web python Barranquilla

Comportamiento esperado

Definir en un documento, puede ser contributing o algún otro lineamientos relacionados con estándares de codificación esperados para el proyecto. Considerar el uso futuro de linters para validar que se cumplan dichos estándares.

Comportamiento actual

En el momento la documentación se limita a PEP8 sin embargo para el sitio web deben existir estándares para la codificación del sitio web

Pasos para reproducir el error

1. Abrir el repositorio del proyecto
2. Revisar archivo contributing.md

[GudarJs]

Yo sugeriria usar https://prettier.io/ en lugar de instalar linters.

[Scot3004]

Yo sugeriria usar https://prettier.io/ como uno de los linters a usar, ademas de eslint y stylelint

[Scot3004]

Update, podemos usar husky + prettier, la verdad es que eslint no es muy necesario en este proyecto.

[Scot3004]

Ejecute pylint en los archivos python actuales y encontre los siguientes errores

(venv) scot3004@SeCOrTo-V:~/proyectos/comunidades/django-quilla-web$ pylint --recursive=y tests scripts
************* Module tests.conftest
tests/conftest.py:11:0: E0401: Unable to import 'dotenv' (import-error)
tests/conftest.py:7:0: C0411: standard import "from typing import Generator" should be placed before "import pytest" (wrong-import-order)
************* Module scripts.events
scripts/events.py:6:0: C0301: Line too long (159/100) (line-too-long)
scripts/events.py:7:0: C0301: Line too long (137/100) (line-too-long)
scripts/events.py:15:50: C0303: Trailing whitespace (trailing-whitespace)
scripts/events.py:16:0: C0304: Final newline missing (missing-final-newline)
scripts/events.py:4:1: W0511: TODO: Create logic for oauth authentication when required (fixme)
scripts/events.py:1:0: C0114: Missing module docstring (missing-module-docstring)
scripts/events.py:6:22: W3101: Missing timeout argument for method 'requests.get' can cause your program to hang indefinitely (missing-timeout)
scripts/events.py:7:24: W3101: Missing timeout argument for method 'requests.get' can cause your program to hang indefinitely (missing-timeout)
scripts/events.py:15:5: W1514: Using open without explicitly specifying an encoding (unspecified-encoding)

-----------------------------------
Your code has been rated at 6.88/10