diff --git a/src/data/roadmaps/code-review/content/api-semantics.md b/src/data/roadmaps/code-review/content/api-semantics.md index 462d825a6..63ea800bb 100644 --- a/src/data/roadmaps/code-review/content/api-semantics.md +++ b/src/data/roadmaps/code-review/content/api-semantics.md @@ -6,3 +6,9 @@ - Clean split of API/internals without internals leaking into the API? - Are there no breaking changes to user-facing parts (API classes, configuration, metrics, log formats, etc)? - Is a new API generally useful and not overly specific to a single use case? + +Learn more from the following resources: + +- [@article@API Design Best Practices Guide - Fern](https://buildwithfern.com/post/api-design-best-practices-guide) +- [@article@RESTful API Resource Naming](https://restfulapi.net/resource-naming/) +- [@article@Web API Design Best Practices - Microsoft Azure](https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design) diff --git a/src/data/roadmaps/code-review/content/code-style.md b/src/data/roadmaps/code-review/content/code-style.md index 93eb53cfe..0d5c457dc 100644 --- a/src/data/roadmaps/code-review/content/code-style.md +++ b/src/data/roadmaps/code-review/content/code-style.md @@ -4,3 +4,9 @@ - Does it adhere to the agreed-upon naming conventions? - Is it DRY? - Is the code sufficiently "readable" (method lengths, etc.)? + +Learn more from the following resources: + +- [@article@The Standard of Code Review - Google](https://google.github.io/eng-practices/review/reviewer/standard.html) +- [@article@Creating a Coding Style Guide for Your Team - Graphite](https://graphite.com/guides/creating-coding-style-guide) +- [@article@Code Smells - Refactoring Guru](https://refactoring.guru/refactoring/smells) diff --git a/src/data/roadmaps/code-review/content/documentation.md b/src/data/roadmaps/code-review/content/documentation.md index f63f5837d..5476eea9e 100644 --- a/src/data/roadmaps/code-review/content/documentation.md +++ b/src/data/roadmaps/code-review/content/documentation.md @@ -3,3 +3,9 @@ - Are the new features reasonably documented? - Are all relevant types of documentation covered, such as README, API docs, user guide, reference docs, etc? - Is the documentation understandable and free of significant typos and grammar mistakes? + +Learn more from the following resources: + +- [@article@How to Write Software Documentation - Write the Docs](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/) +- [@article@8 Essential Code Documentation Best Practices - Heretto](https://www.heretto.com/blog/best-practices-for-writing-code-documentation) +- [@article@Looking for Things in a Code Review - Google](https://google.github.io/eng-practices/review/reviewer/looking-for.html) diff --git a/src/data/roadmaps/code-review/content/implementation-semantics.md b/src/data/roadmaps/code-review/content/implementation-semantics.md index 182d9926b..d1e1d01a8 100644 --- a/src/data/roadmaps/code-review/content/implementation-semantics.md +++ b/src/data/roadmaps/code-review/content/implementation-semantics.md @@ -8,3 +8,9 @@ - Is it secure (i.e., no SQL injections, etc.)? - Is it observable (i.e., metrics, logging, tracing, etc.)? - Do newly added dependencies pull their weight? Is their license acceptable? + +Learn more from the following resources: + +- [@article@Three Pillars of Observability: Logs, Metrics and Traces - IBM](https://www.ibm.com/think/insights/observability-pillars) +- [@article@Security Code Review Checklist - Redwerk](https://redwerk.com/blog/security-code-review-checklist/) +- [@article@What Is Clean Code? - Codacy](https://blog.codacy.com/what-is-clean-code) diff --git a/src/data/roadmaps/code-review/content/index.md b/src/data/roadmaps/code-review/content/index.md index 4e768b56d..5f0d7ea08 100644 --- a/src/data/roadmaps/code-review/content/index.md +++ b/src/data/roadmaps/code-review/content/index.md @@ -1 +1,5 @@ -# \ No newline at end of file +# + +Learn more from the following resources: + +- [@official@Google Engineering Practices](https://github.com/google/eng-practices) \ No newline at end of file diff --git a/src/data/roadmaps/code-review/content/tests.md b/src/data/roadmaps/code-review/content/tests.md index a4e5e0131..840142526 100644 --- a/src/data/roadmaps/code-review/content/tests.md +++ b/src/data/roadmaps/code-review/content/tests.md @@ -5,3 +5,9 @@ - Are corner cases tested? - Is it using unit tests where possible, integration tests where necessary? - Are there tests for NFRs, e.g. performance? + +Learn more from the following resources: + +- [@article@Unit Testing Best Practices - IBM](https://www.ibm.com/think/insights/unit-testing-best-practices) +- [@article@Integration Testing - Microsoft Engineering Playbook](https://microsoft.github.io/code-with-engineering-playbook/automated-testing/integration-testing/) +- [@article@The Practical Test Pyramid - Martin Fowler](https://martinfowler.com/articles/practical-test-pyramid.html)