Welcome — this is a small, open project, and contributions are warmly welcomed. You don't need to be an expert. You don't need to write a long article. Even one short note is valuable.
This project started as an article — What Code Reviews Taught Me Over Time — and is now open for everyone to add their own notes.
- Fork this repository.
- Create a new file in the
/notesfolder. Name ityour-github-username.md. - Write your notes in any structure you like.
- Open a pull request with the title:
Add notes from @your-github-username.
Anything you've learned from reviewing code. Some ideas:
- A bug pattern you keep finding
- A small habit that made your reviews better
- A comment you keep leaving (and wish you didn't have to)
- A story from a real PR — what happened, what you learned
- A linter rule or tool that helped your team
- One short paragraph, or a list of ten things — both are great
If you don't know where to start, copy this:
# Notes from @your-github-username
A short line about you — what you work on, what kind of code you review.
## Lesson 1: [Short title]
What you learned, in one or two paragraphs.
## Lesson 2: [Short title]
What you learned, in one or two paragraphs.- Be kind. Don't name specific people or companies in negative ways.
- Be honest. Write what you actually experienced, not what sounds smart.
- Be clear. Simple English is fine — better than fancy English. Many developers here are not native English speakers.
- No promotional content. This is a notes collection, not an ad space.
Open an issue, and we'll figure it out together.