Skip to content

Create a real good-first-issue on-ramp (8-12 shallow issues) #286

Description

@eaitbrahim

The four currently open issues (#233, #259, #260, #198) are all deep: they require understanding the execution path, the backtest engine, or the broker port. There is no way for a newcomer to make a first contribution. A project with no shallow work gets no first-time contributors, regardless of how welcoming the README is.

Do

  • Identify and file 8–12 genuinely shallow issues, labelled good first issue, each self-contained and reviewable in isolation. Candidates already visible:
    • a docs/ page for one existing rail, explaining it for a reader who is not the author
    • test coverage for a specific uncovered branch
    • a keel-broker-* adapter stub with the port implemented and every method raising NotImplementedError
    • CLI --help text improvements where wording is known to confuse
    • the .mypy_cache/ gitignore gap noted during review
  • Each must state: the file to touch, what "done" looks like, and how to verify it
  • Add help wanted to a second tier of medium issues

Anti-pattern to avoid

Do not label a deep issue good first issue to fill the list. A newcomer who picks one up and drowns does not come back.

Metadata

Metadata

Assignees

Labels

help wantedExtra attention is neededopen-sourceWork toward making keel genuinely open source

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions