etude-github

GitHub Practice Repository for Beginners

Overview

This repository is designed to help beginners learn Git, GitHub, and GitHub Flow. The assumed environment is macOS, Zsh, and VS Code.

Prerequisites

• Node.js (LTS recommended)
• Git
• VS Code

Setup

Install dependencies after cloning:

npm install

Practice Documents

File	Description
docs/01-getting-started.md	Setting up Git and cloning the repository
docs/02-git-basics.md	Core Git commands and concepts
docs/03-github-flow.md	The GitHub Flow branching workflow

Tooling

Linting

Markdown files are linted with markdownlint-cli2. Rules are configured in .markdownlint.json.

Run the linter manually:

npm run lint:md

The linter also runs automatically on every commit via a Husky pre-commit hook.

Commit Messages

Commit messages must follow the Conventional Commits specification, enforced by commitlint.

Use the interactive Commitizen prompt instead of git commit:

npm run commit

Examples of valid commit messages:

feat: add login page
fix: correct broken navigation link
docs: update README