Skip to content

Commit d909c0c

Browse files
feat(code-review): add resource links to all 6 topics (#10012)
* feat(vibe-coding): add resource links to all 54 topics Added verified article links to all vibe-coding roadmap topics. Every topic now has at least 3 high-quality resource links. - 25 topics filled from 0 links - 7 topics filled from 1 link to 3 - 7 topics filled from 2 links to 3 - 15 existing topics already had 3+ links (preserved) - 96 new links added, all verified HTTP 200 - Zero duplicate URLs across new additions - No body text modified, no existing links removed * feat(code-review): add resource links to all 6 topics - index: 1 link (Google Engineering Practices) - code-style: 3 links (Google, Graphite, Refactoring Guru) - documentation: 3 links (Write the Docs, Heretto, Google) - tests: 3 links (IBM, Microsoft, Martin Fowler) - implementation-semantics: 3 links (IBM, Redwerk, Codacy) - api-semantics: 3 links (Fern, RESTful API, Microsoft Azure) 16 total links, 0 duplicates, all verified HTTP 200 --------- Co-authored-by: nehaturov-hue <nehaturov-hue@users.noreply.github.com>
1 parent 2ae46be commit d909c0c

6 files changed

Lines changed: 35 additions & 1 deletion

File tree

src/data/roadmaps/code-review/content/api-semantics.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,9 @@
66
- Clean split of API/internals without internals leaking into the API?
77
- Are there no breaking changes to user-facing parts (API classes, configuration, metrics, log formats, etc)?
88
- Is a new API generally useful and not overly specific to a single use case?
9+
10+
Learn more from the following resources:
11+
12+
- [@article@API Design Best Practices Guide - Fern](https://buildwithfern.com/post/api-design-best-practices-guide)
13+
- [@article@RESTful API Resource Naming](https://restfulapi.net/resource-naming/)
14+
- [@article@Web API Design Best Practices - Microsoft Azure](https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design)

src/data/roadmaps/code-review/content/code-style.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,9 @@
44
- Does it adhere to the agreed-upon naming conventions?
55
- Is it DRY?
66
- Is the code sufficiently "readable" (method lengths, etc.)?
7+
8+
Learn more from the following resources:
9+
10+
- [@article@The Standard of Code Review - Google](https://google.github.io/eng-practices/review/reviewer/standard.html)
11+
- [@article@Creating a Coding Style Guide for Your Team - Graphite](https://graphite.com/guides/creating-coding-style-guide)
12+
- [@article@Code Smells - Refactoring Guru](https://refactoring.guru/refactoring/smells)

src/data/roadmaps/code-review/content/documentation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,9 @@
33
- Are the new features reasonably documented?
44
- Are all relevant types of documentation covered, such as README, API docs, user guide, reference docs, etc?
55
- Is the documentation understandable and free of significant typos and grammar mistakes?
6+
7+
Learn more from the following resources:
8+
9+
- [@article@How to Write Software Documentation - Write the Docs](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/)
10+
- [@article@8 Essential Code Documentation Best Practices - Heretto](https://www.heretto.com/blog/best-practices-for-writing-code-documentation)
11+
- [@article@Looking for Things in a Code Review - Google](https://google.github.io/eng-practices/review/reviewer/looking-for.html)

src/data/roadmaps/code-review/content/implementation-semantics.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,9 @@
88
- Is it secure (i.e., no SQL injections, etc.)?
99
- Is it observable (i.e., metrics, logging, tracing, etc.)?
1010
- Do newly added dependencies pull their weight? Is their license acceptable?
11+
12+
Learn more from the following resources:
13+
14+
- [@article@Three Pillars of Observability: Logs, Metrics and Traces - IBM](https://www.ibm.com/think/insights/observability-pillars)
15+
- [@article@Security Code Review Checklist - Redwerk](https://redwerk.com/blog/security-code-review-checklist/)
16+
- [@article@What Is Clean Code? - Codacy](https://blog.codacy.com/what-is-clean-code)
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
#
1+
#
2+
3+
Learn more from the following resources:
4+
5+
- [@official@Google Engineering Practices](https://github.com/google/eng-practices)

src/data/roadmaps/code-review/content/tests.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@
55
- Are corner cases tested?
66
- Is it using unit tests where possible, integration tests where necessary?
77
- Are there tests for NFRs, e.g. performance?
8+
9+
Learn more from the following resources:
10+
11+
- [@article@Unit Testing Best Practices - IBM](https://www.ibm.com/think/insights/unit-testing-best-practices)
12+
- [@article@Integration Testing - Microsoft Engineering Playbook](https://microsoft.github.io/code-with-engineering-playbook/automated-testing/integration-testing/)
13+
- [@article@The Practical Test Pyramid - Martin Fowler](https://martinfowler.com/articles/practical-test-pyramid.html)

0 commit comments

Comments
 (0)