carpentries-incubator / carpentries-incubator/python-packaging-publishing

Improve README discussion in 02-project-setup

Open
#51 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
Python
Stars
24
Forks
14
PR merge metrics
No merged PRs in 30d

Description

make links to good readmes more direct, expand on components,

Contributor guide

Open the contributing guide

Research direction

Start with the README discussion in 02-project-setup and review how it currently links to other READMEs and explains components. Identify the intended direct links and component coverage from the surrounding lesson content. Done means the links are more direct and the component discussion is expanded in the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.