clean up repo
Personne n'a encore pris cette issue.
- #35 par @adaaaam — fermée sans fusion
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- Active
- Stack technique
- jupyter-notebook
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Jupyter Notebook
- Étoiles
- 1
- Forks
- 4
- Merge moyen
- 1 j 17 h
- PR mergées (30 j)
- 4
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de aboutcode-org/healthycode
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
aboutcode-org/healthycode#23 ·
-
fix headers on public demoOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
aboutcode-org/healthycode#19 · 1 commentaire ·
-
healthycode: Document HealthyCode Deployment sizing parameters (Compute/Memory/Storage)Peut-être pris @d4rshnn l’a pris il y a 10 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 52/100
aboutcode-org/healthycode#26 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
aboutcode-org/healthycode#25 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
aboutcode-org/healthycode#24 ·
Toutes les issues de aboutcode-org/healthycode
Issues similaires
-
marketing
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour
-
Add Royalty funding badgeOuverte
Difficulté 1/5 1-3 heures Accessibilité débutants 78/100
crosspoint-reader/crosspoint-reader#4535 ·
Les mainteneurs répondent en général sous 1 jour
-
automated issue report
Difficulté 1/5 Moins d'une heure Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
self-host
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
funmusicplace/mirlo#2625 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 Une demi-journée Accessibilité débutants 85/100
sindresorhus/eslint-plugin-unicorn#4034 ·
Les mainteneurs répondent en général sous 1 jour