CCExtractor: Add comments in code
Task
CCExtractor has a large codebase written in C, which, despite its efficiency, at times might not be as readable as we want.
https://github.com/CCExtractor/ccextractor
The task is to look into our codebase and find places (can be functions, loops, if-statements, ect.) where you find its function confusing. This task will also help you to understand our codebase and get started on other coding tasks.
Examples of good comments: comments about "jargons" used in code, functions/variables with confusing name, magic numbers...
Examples of bad comments: Comments about C programming grammar, irrelevant comments, comments about obvious things (i.e. "int x; // declares a variable named x").
Skills
What you will learn here: C programming language, the codebase of CCExtractor, git pull requests.
Submission
- Add comments where you think they would be helpful.
- Send a PR (Pull Request)
Task tags
Students who completed this task
Task type
- chrome_reader_mode Documentation / Training
- done_all Quality Assurance