Issue fixing walkthroughs for others to learn from
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
This is not my idea, an llvm Discord user "jjasmine" suggested it to someone asking how to get started:
```
im also a beginner but it's best to go through the llvm kaleidoscope tutorial first and try to shadow some good first issues, i.e repeat what the code author does and try to see for yourself why it works and maybe then you're ready for some first issues yourself
```
I think we could encourage this by deliberately working on some selected issues with this in mind. So that the issue itself has comments that document what approach was taken and why. This might fill in the gap between the issue content and the final PR, which only includes an explanation of the final changes, and even then, it may be very brief.
For example for a code generation issue, you might have "First I narrowed down the effected targets by trying a few triples" then include the commands. "I knew it must only effect 64 bit targets because...", but maybe "it turned out that this was misleading so instead I....". We could then collect links to these write ups in some place in the documentation, near where we suggest the "good first issue" tag.
A nice side effect of this is that although they could grow out of date, they will be linked to a time frame and hashes for before and after the fix. I think the principles shown would remain useful over time.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the proposed walkthrough approach in this issue and the existing documentation near the good first issue guidance. Determine which selected issues should receive explanatory comments and where links to those write-ups should be collected; done means the scope and documentation location are agreed and the examples are linked with their relevant time frame and hashes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100