lucasvazq / cushead

CLI that help you to improve the SEO and UX of your websites.
MIT License
4 stars 0 forks source link

ISSUE: Ordenar Issues #177

Open lucasvazq opened 4 years ago

lucasvazq commented 4 years ago

Description

Crear un issues generales para:

Además, ordenar el flujo de trabajo: Primero se tiene que corregir la funcionalidad en sí, después crear los test, luego arreglar la documentación, corregir los labels, y por último, cuando todo esté estable, agregar las aplicaciones.

A partir de ahí, comenzar a buscar nuevos features y revisar los guardados en Fav

subzero-taringuero[bot] commented 4 years ago

Thanks for opening this issue!

lucasvazq commented 4 years ago

README.md

1) Add packaging status badget like polybar repo: https://github.com/polybar/polybar #171 2) Add vulnerabilities badget: https://github.com/riyadhalnur/issuelabeler (NEW) 3) new recommendations #129 (no closed) 4) Mention all availables docs (NEW) 5) Recomendation: The svg image download trick: #18 You need to use svg for a lot of things like logos or some icons, But some user, when download it, don't know how to use them. I propose to add opacity 0% png file covering the svg, and when the user right click and press "Download" the image, he really download the png file and not the "hard to use and edit" svg file. You need to mentinoned by the users, but if users can't do that, you can't spread your Brand 6) Separate version from logo #17 Also, add the logo in the "social" settings on Github project settings 7) RECOMENDATION: the usage of polyfill for js and css #8

CONTRIBUTING.md

1) Finish contributing.md and improve travis-ci #141 Improve TravisCI description, mentioning the fact that it runs coverage (mention packets and apps) and deployment tests. 2) All apps that the project have is in CONTRIBUTING.md? Also, all apps mentioned in that File are installed? (NEW) 3) Doc this: FIX label work for anything that must be chaged (NEW)

NEW DOCUMENTATION

1) New documentation #142 (no closed) 2) List working apps #117 3) Generate example files, mention it on README and wiki #44 4) LABELS.md 4) Workflow.md: EXAMPLE: when new label is added, you need to mention it on CONTRIBUITING.md and LABELS.md, also, the new label must be part of a group and have a specific color. (NEW)

WIKI

1) Online method/classes docs #146 Generate online docs 4 each function like python online docs https://docs.python.org/3/ Tool: pydoc https://docs.python.org/3.8/library/pydoc.html

Labels

Requiere agregarlas en CONTRIBUTING.md 1) duplicated label #166 2) CI/CD: related to github, applications and tools (red color) #166 3) review colors #166 4) add improve code label (red color) (NEW): Usage -> when code need revision and don't know the existence of an issue 5) Replace label 'review' w 'analysis' #128 The analysis label is used to make a global analysis about anything. 6) Labels revision #77

Github, applications and tools

1) Add MyPy linter: static type checker #161 2) improve repo files #159 .editorconfig https://github.com/pypa/pipenv/blob/master/.editorconfig .gitattributes https://github.com/pypa/pipenv/blob/master/.gitattributes .gitignore https://github.com/pypa/pipenv/blob/master/.gitignore .gitmodules https://github.com/pypa/pipenv/blob/master/.gitmodules pyrpoject.toml and build-system https://www.python.org/dev/peps/pep-0518/#build-system-table https://github.com/pypa/pipenv/blob/master/pyproject.toml https://martin-thoma.com/pyproject-toml/ travis & Makefile https://pipenv-es.readthedocs.io/es/latest/advanced.html#travis-ci 3) Add core_requirements.txt, here listed the real required apps (NEW) 4) Add changelog https://github.com/PyCQA/pylint/blob/master/ChangeLog or relases notes #156 5) add check-run-reporter app #152 It coments the motive of why a CI fails, directly in the repo https://www.check-run-reporter.com/ Requires the CI platform works with JUnit. And Travis do it. https://github.com/softwaresaved/build_and_test_examples/blob/master/travis/Languages.md 6) Remove create-issue-branch (NEW) 7) Custom create branch from issue when X label is assigned, and base branch is defined with the label (NEW) 8) Integrate CIRCLE CI #126 9) Review all applications permissions and usage #38 10) Add AZURE: #34 Test with azure pipeline (test module in diferents OS) 11) Auto release when new merge into MASTER, and Add auto pip release when new release is created (NEW) The autorelease must follow standarts releases format (look for ~=auto-release application)

FEATURES

1) Look for vueUI and PWA generator https://www.youtube.com/watch?v=-y5xYznyQ1A 13:06 #153 2) allow comments in json w minifier #148 Idea: json parser that delete the comments Tool: https://github.com/getify/JSON.minify/tree/python 3) CLI usage #143 Tool: DOCOPT: http://docopt.org/ This helps to generate the help usage statement Considerations: https://stackoverflow.com/questions/9725675/is-there-a-standard-format-for-command-line-shell-help-text 4) handle the garbage #127 Take a look for del and gc.collect() 6) Add images output mention in --images #80 (no closed) 7) add NoReturn type hint #79 8) TODO: look at modernizr, html5 boilerplate #28

FIX and CHANGES

1) Remove related applications manifest https://app.leanboard.io/board/c53baec9-e919-46f0-ad26-ec32ebb7b11f 2) Remove meta keywords #81 Unused, what about meta-tag description? 3) Images must follow the next format: NAME_TYPE_SIZEpx: ej: favicon_png_1600px (NEW) 4) Search for images with good resolution (NEW) 5) very important: REMOVE IE COMPATIBILITY https://www.vieodesign.com/blog/why-we-abandoned-ie11 (NEW)

IMPROVE CODE

1) Lambda usage #147 (no closed) 2) strings join method #145 Look if in somewhere strings beign joined using operators like str1 = str2 + str3, and replace them with ''.join() 3) Look for the usage of dict(), list(), tuple(), set(), and change it for {}, [], () (NEW) 4) change start class variables like color_config: dict with color_config = {} (NEW) 5) move read_user_config #92 Move read_user_config from console to module/config 6) Change settings file structure #88 Replace "recomended" w images. Cambiar esto en las settings creadas con el comando que genera settings por defecto 7) S&D all * #53

ANALYSIS or REVIEW

1) Test favicons load flow #57 If a browser has three favicons to select. What should it prefer? The head tag must have the favicons sorted according to what the browser commonly prefers

LAST

Last things to be resolved 1) Python 3.8 #144 (no closed) 2) Test mode in CLI #56 (no closed) 3) React output #47 (no closed) 4) Check all variables names (NEW) 5) General TESTS (NEW)

REMOVED

140

122

45

54

55