This page cannot be shown here. You can still read it on the original site — the toolbar below keeps your place in the directory.
TL;DR: add an ARCHITECTURE.md document to make contributing to your codebase easier for newcomers A high-level map of the codebase architecture helps newcomers find where to start reading An ARCHITECTURE.md document should cover: how different sections of the codebase work together things that don’t change often (once or twice a year at most) Do name important files, modules, and types. Do…
TL;DR:
- add an
ARCHITECTURE.md document to make contributing to your codebase easier for newcomers
- A high-level map of the codebase architecture helps newcomers find where to start reading
- An
ARCHITECTURE.md document should cover:
- how different sections of the codebase work together
- things that don’t change often (once or twice a year at most)
Do name important files, modules, and types.
Do not directly link them (links go stale).
Comments
Nothing yet. Say the first thing.
Sign in to join the conversation.