docs: update the project layout in CONTRIBUTING.md to the current commands and files
Maintainers usually reply within 1 day
Assessment
This issue has not been assessed yet.
Description
The "Project layout" section in CONTRIBUTING.md still lists four commands (snowflake, perms, invite, intents), but there are twelve now, and the docs/ folder and a few other files are missing. New contributors use this tree to find where things live, so it should be right.
What to do
- Update the tree under "Project layout" so that it matches
src/dkit/as it is onmaintoday: every module incommands/and every file indata/. - Keep the short comments in the right-hand column (one line per module or folder is enough, no essays).
- Check that the rest of
CONTRIBUTING.mdstill matches reality: the example in "How to add a new command" and the setup commands. If something is out of date, fix it in the same PR and mention it in the description. - If you want to keep the tree from going stale, you may add one sentence that tells people to update it when they add a command. Please no automatic tooling in this PR.
Notes
- Docs only, no code or data changes, no CHANGELOG entry needed.
- Please run
ruff check .and the tests anyway before you open the PR.
Please comment on this issue before you start (see CONTRIBUTING.md). AI-assisted contributions are welcome, please mention it in the PR description.
- Dominant language
- Python
- Stars
- 1
- Forks
- 7
- Avg merge
- 11h 50m
- Merged PRs (30d)
- 35
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the 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 Bytewave1/dkit
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
enhancement good first issue new command
Difficulty 3/5 1-2 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
-
enhancement good first issue new command
Difficulty 3/5 1-2 days Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
enhancement new command
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#147104 ·
Maintainers usually reply within 1 day
-
premises-missing
Difficulty 1/5 Under an hour Newbie friendliness 88/100
WingedGuardian/GENesis-AGI#3801 ·
Maintainers usually reply within 1 day
-
[oblt-aw][autodoc] Document new required `shared-org-key` input for `obs-aw-dependency-review`Possibly taken @github-actions claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
bot-triaged module: inductor oncall: pt2 topic: fuzzer triaged
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 4 days