Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs: bring `docs/ISSUES.md` up to date (several "ideas" are already built)

Open Beginner friendly
  • Is something wrong?
#86 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown, python
Domain
documentation

Research direction

Read docs/ISSUES.md, then check the linked implementation history or CHANGELOG for completion PR numbers and verify which entry 8 bullets are already covered. Update the status and issue references, and revise the intro plus the descriptions in README.md and CONTRIBUTING.md. Done when those docs accurately distinguish completed ideas from open issues and retain docs/ISSUES.md.

Written by the indexing model from the issue text.

Description

documentation good first issue

docs/ISSUES.md presents "eight ready-to-file good first issues", and README.md and CONTRIBUTING.md point to it. But most of the entries are already implemented and only two of them say so (#2 timestamp and #7 cross-platform). These ideas are built and still described as open:

    1. dkit channels (exists)
    1. dkit locales (exists)
    1. Shell completion for bash, zsh and fish (exists, dkit completion)

Still open on GitHub: #4 dkit overwrites (issue #4) and #5 dkit update-data (issue #5). Entry 8 ("Broaden the test suite") is partly done already (pytest-cov and hypothesis are in the dev extra, and there are property-based round-trip tests), please check each bullet.

What to do

  • Mark every finished entry with **Status:** Done in #N. (find the PR numbers in the git history or the CHANGELOG), like entries 2 and 7 do. Add the issue number to the still-open entries.
  • In entry 8, strike or rewrite the bullets that are already done so the remaining ones are really open.
  • Update the intro ("Eight ready-to-file...") and the sentence in README.md (around the Contributing section) that describes the file, so both stay true. Check CONTRIBUTING.md for the same.
  • Do not delete the file in this PR. If you think the file should be retired because GitHub issues are the source of truth, say so in a comment on this issue instead.

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
5h 5m
Merged PRs (30d)
30

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Bytewave1/dkit

All issues in Bytewave1/dkit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.