Skip to content

DOC: refinamento da documentação e do README #2

@TheoRiffel

Description

@TheoRiffel

Documentar o código a fim de torná-lo entendível para as próximas gerações.

uma refatoração do README é necessária e urgente.

links para se inspirar 🔥🔥🔥

https://en.wikipedia.org/wiki/Zen_of_Python
https://blog.codacy.com/code-documentation
https://www.builtinnyc.com/articles/mantras-clean-code-best-practices

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions