KhronosGroup / KhronosGroup/syclacademy
Exercise solution should be commented and understandable
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 542
- Forks
- 121
- PR merge metrics
- No merged PRs in 30d
Description
We got a problem for example with https://github.com/codeplaysoftware/syclacademy/blob/main/Code_Exercises/Exercise_15_Image_Convolution/reference.cpp when everybody were trying to understand the details, including the presenter.
@AerialMantis please add comments. :-)
Contributor guide
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 reading Code_Exercises/Exercise_15_Image_Convolution/reference.cpp, the file linked in the issue, and identify the parts whose details were difficult for learners and the presenter to follow. Add comments that make the exercise understandable, with completion indicated by the code being clearly explained in place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100