Separate out instructions in README.md for template users and their users
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading README.md and identify the instructions intended for people creating a project from the template versus people using this repository directly. Separate those workflows so template users are directed to git init while repository users are directed to clone the repo, then verify both paths are clear.
Written by the indexing model from the issue text.
Description
Specifically, the README tells users to run git init, which you will want to do if you have just created a new project using the template, but if you're someone using this repo, you don't want to run git init! Instead you should clone the repo first.
Maybe we should have separate sections in the README?
- Dominant language
- Python
- Stars
- 14
- Forks
- 8
- Avg merge
- 15m
- Merged PRs (30d)
- 1
Getting set up
- No Dockerfile or Docker Compose file
- Has a 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 ImperialCollegeLondon/python-template
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ImperialCollegeLondon/python-template#568 · 1 comment ·
-
Add all contributors configMay be free again @alexdewar claimed this 128 days ago, and no pull request is open. Open
ImperialCollegeLondon/python-template#558 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
All issues in ImperialCollegeLondon/python-template
Similar issues
-
Layers of type "3D Unknown" and "3D Measured Unknown" are refused, so FileGDB multipatch layers can't be readPossibly taken @aidannewsome claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
quantization
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/vllm#59904 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mikf/gallery-dl#9791 ·
-
Speaker custom-fields CSV export returns 404 instead of downloading dataPossibly taken @techvoyager-varun claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
fossasia/eventyay#6151 · 1 comment ·
Maintainers usually reply within 1 day
-
P4: low tooling
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
jeffknupp/association#318 ·