Contributing Guidelines

Topic guides take a few different forms but generally speaking each guide is of one of these types:

Topic introduction and cheatsheet
- e.g Data Structures (Linked List), Algorithms (Traversals)
- Generally introductory, description of the topic, time/space complexity notes
- Examples of common problems
- Links to videos or other resources for further reading
Algorithm Pattern Breakdowns - Use case guides
- e.g Manipulating a LinkedList, 2-Pointer tracking
- Describe the pattern and when it's generally used, example of problems where that is used
- Example of one or two problems and solutions leveraging this pattern
- Specific solution example (e.g. Length of the longest substring without repeating characters)

Data Structure Topic Intro Sections

e.g Linked List, Binary Trees

Executive Summary - Paragraph or two that provides as much an overall summary as possible. The specifics of the data structure, why and when this structure, the tl;dr of pros and cons of using this structure.
Introduction - Setup more context for this data structure including a visual example or two of how this structure is illustrated, small code snippets representing the structure
Time/Space Complexity - Table or description of the common O(n) for this structure on various operations
Pros and Cons - List of the advantages and disadvantages of this structure in more detail
Glossary - List of common terminology (should cover most anything used in the page or patterns)
Basic Operations - Code and descriptions for basic operations (too simple to be a full pattern)
Patterns List - List of links to the common memorized or "derived" algorithm patterns for this data structure
References - List of external links for additional reading on this structure

e.g Dynamic Programming

Executive Summary - Paragraph or two that provides as much a content-rich overall summary as possible. The specifics of the algorithm, why and when this algorithm is used, the tl;dr of pros and cons of using this structure.
Introduction - Setup more context for this algorithm including a visual example or two of how this is illustrated
Time/Space Complexity - Table or description of the common O(n) for this algorithm for major variations
Glossary - List of common terminology (should cover most anything used in the page or patterns)
Basic Elements - Code and descriptions for major elements of this algorithm (i.e Memoization)
Patterns List - List of links to the common memorized or "derived" patterns/techniques for this algorithm
References - List of external links for additional reading on this algorithm

e.g 2-Pointer Tracking for Linked List

Executive Summary - Paragraph or two that provides as much a content-rich overall summary as possible. The specifics of the pattern, why and when this pattern is used.
Introduction - Setup more context for this pattern, the specifics of the mechanics (illustrated with visually / code / description, whatever is easiest)
Pose Canonical Problem - Pick a canonical problem that can be solved primarily applying this pattern or technique. Pose the problem and setup context for why this pattern is needed (e.g explain why alternative approach would be insufficient or less efficient)
Solve Canonical Problem - In a step-by-step manner, break down the problem and solve this problem by leveraging the pattern described. Do this in a manner that gradually reveals the solution over 2-4 solution iterations to make this easier to pick-up.
(If needed) Pose 2nd problem - When needed, if the pattern has multiple distinct variations, to drive the point home, post, breakdown and solve a second problem demonstrating the pattern in a new context.
Problems List - List 2-5 other seemingly distinct problems (maybe title with link to LeetCode) in which this pattern (or small variation) would be a principal component of the solution.
References - List of external links for additional reading on this algorithm