Tag: #semantic versioning

This document details best practices for creating and maintaining a changelog, a chronologically ordered list of notable project changes. It emphasizes human readability and recommends using a consistent format (like Keep a Changelog) with categorized changes (added, changed, removed, fixed). The guide discourages using raw git logs and highlights the importance of including deprecations and yanked releases. It also provides examples of good and bad changelog practices, addressing common questions and offering guidance on reducing maintenance effort. Finally, it encourages community contributions to refine the proposed standard.

Conventional Commits is a specification for creating standardized commit messages, improving readability and automation. Messages follow a `<type>[optional scope]: <description>` format, with optional body and footers. Types like `fix` and `feat` correlate with semantic versioning (PATCH and MINOR, respectively), while `BREAKING CHANGE` indicates a major version bump. This standardization aids in automated changelog generation, version bumping, and streamlined collaboration. Tools can leverage these structured messages for various automation tasks.

Release Please is a GitHub tool that automates release processes. It generates changelogs, creates GitHub releases, and manages version bumps based on conventional commit messages. It uses Release PRs to keep releases up-to-date before merging. The tool supports various programming languages and can be deployed via GitHub Actions or the CLI. Troubleshooting steps are provided for common issues.

This website documents the Jujutsu (jj) version control system. Navigation is via a sidebar or hamburger menu. Help is available both online and via the `jj help` command (if installed). Documentation covers both released and unreleased (main branch) versions. Useful links include installation, tutorials, and the GitHub repository.