clean up repo

Offen
#33 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

  • #35 von @adaaaam — ohne Merge geschlossen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Aktiv
Tech-Stack
jupyter-notebook
Bereich
documentation

Rechercherichtung

Start by reviewing the repository’s docs folder, requirements files, LICENSE, NOTICE, Makefile, and empty AUTHORS.rst. The issue raises unresolved questions about which files to remove and whether to add CONTRIBUTING and SECURITY files, and also mentions failing deploys and a README review. A clear completion point needs agreement on those decisions and the README review; no specific tests or entry points are named.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Jupyter Notebook
Sterne
1
Forks
4
Ø Merge
1 T. 17 Std.
Gemergte PRs (30 T.)
4

Entwicklungsumgebung

  • Enthält ein Dockerfile oder eine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus aboutcode-org/healthycode

Alle Issues in aboutcode-org/healthycode

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.