always wanteddocumentationgood first issuehelp wantedquestion
Métriques du dépôt
- Stars
- (2 stars)
- Métriques de merge PR
- (Métriques PR en attente)
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:
- What: What is the problem? What is a high-level solution? (Could just be a call for investigation into a solution.) Are there alternatives?
- 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?
- 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?
- 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.