Exploring Large Codebases - Today I Learned

Today I Learned

Search…

Today I Learned

Career

Exploring Large Codebases

Invest in decision-making skills early in career

Pros & Cons of working professionally

Questions to ask in an interview

Writing Cover letter - Tips

Coding Practices

Naming Variables & Functions

Routines: Functions & Procedures

SOLID: Design Principles

Writing Comments

Writing Functions

Databases

Collected notes on Database Sharding 🗃

EXPLAIN queries in PostgreSQL

Getting JSON data from PostgreSQL

DevOps

Blue-Green Deployment Strategy

Chaos Engineering 🐒️

Docker 🐋 quick guide

Distributed Computing

8 Fallacies of Distributed Computing

Distributed Hash Tables (DHT)

Flutter

Decrease lottie size dynamically in flutter

Get all Hive 🐝 boxes

Null aware operators in Dart

Git

Auto-correct Git commands

Find default git branch name

Get current branch name

Get last commit date of file

Get list of all branches

How to undo anything in Git

Parsing `git status` for tracked & untracked changes

View a python function's history over-time with Git & FZF

View git diff since the last git pull

Go

Add version info in Go projects

Anatomy of `go.mod` file

Clearing terminal screen in Go

Convert `string` to `int` and vice-versa in Go

Creating Python's `next()` alternative using Go Closures

Measure Exection time in Go

Parsing changelogs using regex with Go

Reading & Setting Environment variables in Go

Resolving merge conflicts in go.sum

Splitting strings in Go

Using local Go package path

Where are my build files when I use `go run`

Meta

Tech Writing Cookbook - Writing tips for you and my future self

Miscellaneous

Converting videos to High quality GIFs

Creating a Regex Compiler/Parser - Research

Deploying to Heroku

Internet search tips & tricks for developers

Killing Open Ports in Linux

Navigating your way through Github API

Record your Desktop using `ffmpeg`

Releases on GitHub

Running headless Android Emulator

Semantic Versioning

Streaming videos, things behind the curtain

What's a Procfile 👀

Writing Cleaner Commits - Template

Python

Check if csv has header in python

Check indentation errors in python 🐍

Cryptographically strong random string

Difference b/w Class & Function Based Views in Django

Dividing Time deltas in python - Difference b/w 2 datetime values

Downloading files using python the correct way

Easy & Lazy way to flatten a python list

Everything about date & time in python

Fastest Python First: Tips and Tricks 🏃

Functional Programming in Python 🐍

Generate random secure password using python

Measure code execution time using timer

PEP8 - the fashion 💃 police of Python

Preventing global package install with `PIP_REQUIRE_VIRTUALENV`

Publishing a Package on PyPI

Specify dev dependencies in setup.py

Using defaultdict to handle key not in dict

Using difflib in Python for fuzzy string matching

Writing Unit Tests in Python ✅

Shell

Alternative to 'ls' commnand

Changing string case in bash

Check battery status

Colorize Output in Terminal

Copy one file to multiple files in Bash

Extract file id from drive shareable link

FZF: Tips and Tricks

Find boot-up time in linux 🐧

Find files changed 7 days ago

Find fonts available in Linux

Finding all Python Virtual Environments in your system

Finding the file creation date/time on Linux

Generate a RSS Feed of recent files inside a Git repository

Generate random numbers in bash

Get Release notes from Github API

Get System info using Shell Commands

Get Total System Memory using `vmstat` command

Line Discipline in Unix/Linux Machines

Line Editors in Linux, Tips and Tricks

Monitor network (data) usage

Print lines between 2 words

Print value of `$PATH` in readable format

Random emoji 😲 in one line

Reuse arguments from last command

Shell Redirections ↔ Quick Guide

Writing a simple file watcher using GNU Utils

grep cheatsheet

Vim

Configuring LSP on NeoVim

Convert bulleted/unordered lists to numbered lists

How to make Vim faster ⚡️

My Vim Cheatsheet

Searching your way through vim

Sum column values in Vim

ctags in Vim - Quick Cheatsheet

vim surround: quick cheatsheet

WebDev

Auto-complete in plain HTML

I learned about Open Graph protocol

Live Editing HTML

Turning Emojis to site favicons

`async` & `defer` Attributes

Powered By GitBook

Exploring Large Codebases

Posted on 25 May, 2021
Since more than 50% of the time developers spent reading & modifying existing source code rather then writing new one, reading code is an essential skill for a developer that's why I am maintaining a log of resources, tips etc. to explore unknown Codebases
Usually picking a small task will help explore the codebase but ofc as a developer we need some powerstuff as well.
Write a glossary (class/function names, file/variable prefixes), As you read the code and encounter terms/words you don't know, write them down. Try to explain what they mean and how they relate to other terms. Create Docs for yourself
Check commit log in general for some interesting commits.
Check most commonly edited files
Read and run the tests (if any). The tests are (usually) a very clear and simple insight into otherwise complex functionality. This method should do this, this class should do that etc.
Read the documentation and comments (if any). This can really help you understand the how's and why's.
Tools
​ack​
​ag​
​Sourcetrail​
​codetour​
​vim-bookmarks​
When exploring a git repo add these aliases to find more insights like
git top10: most actively edited files.
git his: Examples of commits that modify a file (helps in understanding what needs to be changed)
git wot: See how a function evolved
1
[alias]
2
      # find commits that changed a file: git his <filepath>
3
      his = log --follow --color=always --date=format:'%d %b, %Y' --pretty=format:'(%Cgreen%h%Creset)[%ad] %C(blue bold)%s%Creset'
4
      # search code in commit history: git wot :function_name:filepath
5
      wot = log --date=format:'%d %b, %Y' --pretty='%n%C(yellow bold)📅️ %ad%Creset by (%C(green bold)%an%Creset) %C(cyan bold)%h%Creset' --graph -L
6
      # top 10 most edited files
7
      top10 = ! git log --pretty=format: --name-only | sort | uniq -c | sort -rg | head -10
Copied!
Resources & Internet Threads
​Ask HN: How do you familiarize yourself with a new codebase?​
​General Guide For Exploring Large Open Source Codebases​
​A better way to learn a new codebase​
​7 tools for visualizing a codebase​

Invest in decision-making skills early in career

Last modified 16d ago

Copy link

Edit on GitHub

Contents

Resources & Internet Threads