crickets-and-comb / crickets-and-comb/comb_utils

Improve/review issues.

Open
#30 0 comments 0 reactions 0 assignees View on GitHub
always wanted documentation good first issue help wanted question
Dominant language
Python
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

We are always looking for help in improving issues (like this one) in our repos. The initial issues created, due to their volume, were high-level place holders.

Even if you don't have a solution to an issue, fleshing it out can help get us closer to a solution.

Issues should include:
1. What: What is the problem? What is a high-level solution? (Could just be a call for investigation into a solution.) Are there alternatives?
2. Why: Why is this problem a problem? Why do we need a solution? What's the impact of not solving the problem? What's the impact of solving the problem?
3. How: How will we implement the solution? What is a lower-level description of the solution? What tools and resources will we use, where? What's the somewhat detailed, step-by-step process we will follow? Are there alternative approaches?
4. Success criteria: How will we know we have solved the problem? How will we test the solution?

Even if you can't flesh the entire issue out, it can be helpful to offer relevant discussion and ideas, or point to useful resources and tools.

Contributor guide

Open the contributing guide

Research direction

Start with issue #30 and review its four requested sections: What, Why, How, and Success criteria. Done means the issue is fleshed out with relevant discussion, alternatives, implementation details, resources, and a way to test or recognize the solution; no source files or tests are named.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.