stevedunn / vogen.serialization

Learn using Shoulder.dev

Shoulder.dev transforms codebases into tailored learning experiences. Below are organized categories of the codebase to help you start with your initial focus.

Value Objects

Reason: Understanding the core concept of Value Objects and their role in the codebase. How they are implemented in C#. Benefits of using Value Objects. How Vogen generates Value Objects. Value Object equality and immutability.

Serialization

Reason: Learning about how data is transformed into a format suitable for transmission or storage. Different serialization formats (JSON, XML, etc.). How serialization is used in the codebase. Considerations for choosing a serialization format.

Newtonsoft.Json

Reason: Understanding the popular Newtonsoft.Json library and its usage in the codebase. How to serialize and deserialize objects using Newtonsoft.Json. Custom serialization with JsonConverter. Benefits and limitations of Newtonsoft.Json.

System.Text.Json

Reason: Understanding the native System.Text.Json library and its usage in the codebase. How to serialize and deserialize objects using System.Text.Json. Custom serialization with JsonSerializerOptions. Benefits and limitations of System.Text.Json.

Benchmarks

Reason: Understanding the performance of different serialization approaches. How to measure and interpret benchmark results. Factors that influence serialization performance. Comparing performance of different serialization libraries.

Source Generators

Reason: Learning about source generators and how they are used in the codebase. How source generators generate code at compile time. Benefits of using source generators. How Vogen uses source generators.

Testing and Debugging

Reason: Ensuring the codebase functions correctly and finding and fixing errors. Unit testing techniques. Debugging tools and techniques. Test coverage and best practices.

CI/CD

Reason: Understanding the continuous integration and continuous delivery pipeline for the codebase. Automated build and deployment processes. Build tools and platforms (e.g., Azure DevOps, Jenkins). Continuous integration and continuous delivery best practices.

Code Analysis

Reason: Evaluating the quality and maintainability of the code. Code analysis tools and techniques. Identifying code smells and potential issues. Code style and best practices.

Documentation

Reason: Providing clear and concise instructions for using the codebase. Documentation tools and formats (e.g., Markdown, XML documentation). Effective documentation practices. API documentation.

Security

Reason: Protecting the codebase and sensitive data from vulnerabilities. Secure coding practices. Security vulnerabilities and mitigations. Security testing and analysis.

Version Control

Reason: Tracking changes to the codebase and facilitating collaboration. Version control systems (e.g., Git). Branching strategies. Code review and collaboration.

NuGet Packages

Reason: Understanding how the codebase is packaged and distributed. NuGet package creation and publishing. Package dependencies and management. NuGet package metadata and versioning.

Build System

Reason: Understanding how the codebase is built and compiled. Build tools and platforms (e.g., MSBuild). Build configurations and settings. Build dependencies and management.