Summary of what this does at the start of the README
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Start in the README before the existing Usage instructions and review the information available through the Summary Table image. Add a brief opening section explaining what AppAssessment does, who may use it, and why; done means readers can understand the tool's purpose without scrolling to the image.
Written by the indexing model from the issue text.
Description
It's probably a bit nitpicky, but I would love if instead of starting the README with the Usage instructions, there was an initial section that described what AppAssessment does, who might want to use it and why someone might want to use it. I realize that if you scroll down and click on the image of the `Summary Table' you can find this out, but it would be nice to know at the start of the document.
- Dominant language
- Python
- Stars
- 7
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 bcgov/AppAssessment
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
bcgov/AppAssessment#41 ·
-
It's Been a While Since This Repository has Been UpdatedMay be free again @ShovelHand claimed this 1505 days ago, and no pull request is open. Open
bcgov/AppAssessment#40 · 3 comments · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
bcgov/AppAssessment#38 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
bcgov/AppAssessment#37 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
bcgov/AppAssessment#19 ·
All issues in bcgov/AppAssessment
Similar issues
-
customer-reported
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Azure/azure-cli#34150 · 1 comment ·
Maintainers usually reply within 1 day
-
community-request
Difficulty 1/5 Under an hour Newbie friendliness 95/100
NVIDIA-NeMo/Curator#2464 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
WeblateOrg/translation-finder#1099 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
trezor/trezor-firmware#7997 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day