Skip to content

improve documentation and add code comments #73

@kdabir

Description

@kdabir

Let alone new contributors, even for myself when looking at the project after an year or so, it is very difficult to understand what the specific section of the script does.

  • Create a CONTRIBUTING.md
  • annotate tricky sections of code with comments
  • Create simple how to's, eg:
    • how to add a new tool,
    • how to update tests

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions