clean up repo
Nobody has claimed this yet.
- #35 by @adaaaam — closed without merging
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- jupyter-notebook
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
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.
- Dominant language
- Jupyter Notebook
- Stars
- 1
- Forks
- 4
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 4
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/healthycode
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
aboutcode-org/healthycode#23 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aboutcode-org/healthycode#19 · 1 comment ·
-
healthycode: Document HealthyCode Deployment sizing parameters (Compute/Memory/Storage)Possibly taken @d4rshnn claimed this 10 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 52/100
aboutcode-org/healthycode#26 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
aboutcode-org/healthycode#25 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
aboutcode-org/healthycode#24 ·
All issues in aboutcode-org/healthycode
Similar issues
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
crosspoint-reader/crosspoint-reader#4535 ·
Maintainers usually reply within 1 day
-
automated issue report
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
self-host
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
funmusicplace/mirlo#2625 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 85/100
sindresorhus/eslint-plugin-unicorn#4034 ·
Maintainers usually reply within 1 day