clean up repo
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
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus aboutcode-org/healthycode
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
aboutcode-org/healthycode#23 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
aboutcode-org/healthycode#19 · 1 Kommentar ·
-
healthycode: Document HealthyCode Deployment sizing parameters (Compute/Memory/Storage)Evtl. vergeben @d4rshnn hat das vor 10 Tagen übernommen. Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100
aboutcode-org/healthycode#26 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
aboutcode-org/healthycode#25 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
aboutcode-org/healthycode#24 ·
Alle Issues in aboutcode-org/healthycode
Ähnliche Issues
-
marketing
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 78/100
crosspoint-reader/crosspoint-reader#4535 ·
Maintainer antworten meist innerhalb von 1 Tag
-
automated issue report
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
self-host
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
funmusicplace/mirlo#2625 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 85/100
sindresorhus/eslint-plugin-unicorn#4034 ·
Maintainer antworten meist innerhalb von 1 Tag