Read code, get better.
Reading good stuff is a good way to figure out how to write good stuff. As coders, we spend a lot of time reading code but there's no training out there to help us do it well. Even a 10% improvement at a programmer's ability to read code would translate into significant time savings in a short space of time.
- Fork this repo.
- Make a new branch for a new exercise. Name the branch
<exercise-number>-<your-github-handle>. - Add comments to the exercise using your text editor, explaining what the code does.
- Commit the commented code. Make the commit title
<exercise-number>. In your commit message, write what the code does at a high level. - Push it to your forked repo.
- Make a PR from your forked repo
<exercise-number>-<your-github-handle>branch to the master of the origin repo (https://github.com/sjmog/read). - Browse PRs in the origin repo to see what others thought about the code (click the PR, then click "Files Changed"). You can filter PRs by the exercise number. You can discuss PRs in the discussion.
MVP.
- Load a file by cloning a GH repo containing some examples
- Add line-by-line comments with a text editor
- Add a file-wide comment with a commit
- Can see others’ solutions by making a PR and viewing pull requests
Overall idea:
- Can load up a random new file
- Can do line-by-line comments explaining what something is and how it works
- Can do a file-wide comment
- Can see others’ approaches and discuss
Clearly, some sort of web app would be a good basis to get started. Some sort of open-source code review tool might accelerate development.