Skip to content

clean up repo #33

Open
Open

Description

@adaaaam

Organization

there are files and folders that should be deleted.

we aren't using RTD for this project, so the docs folder generated from the skeleton should be deleted: https://github.com/aboutcode-org/healthycode/tree/main/docs

for a new user, a docs folder that does not include this project's docs can be confusing.

there are also three requirements files and two different license files (LICENSE is GPL-3.0, but NOTICE and the Makefile are Apache-2.0). AUTHORS.rst is empty. should we also have CONTRIBUTING and SECURITY files?

Deploys

the latest deploys are failing: https://github.com/aboutcode-org/healthycode/deployments

is there a plan to resolve this?

README

there are a lot of errors with the latest version of the README. once the above items are resolved, i can do another review to fix broken links, clarity, grammar, etc.

Activity

  1. adaaaam commented on Nov 16, 2026

    @adaaaam
    MemberAuthor

    this is addressed in:
    #36 - update README.md
    #37 - update deploy/README.md
    #38 - create CONTRIBUTING.md
    #39 - update AUTHORS.rst
    #40 - delete apache-2.0.LICENSE
    #41 - delete /docs folder
    #42 - remove extraneous requirements files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions