Commit Guidelines

This document outlines the commit message format and guidelines for beOS.

Commit Message Format

We follow the Conventional Commits specification:

<type>(<scope>): <subject>

<body>

<footer>

Types

feat: New feature
fix: Bug fix
docs: Documentation changes
style: Code style changes (formatting, etc.)
refactor: Code refactoring
test: Test additions or changes
chore: Maintenance tasks
build: Build system changes
ci: CI/CD changes

Scope

Optional, indicates the area of the codebase:

kernel: Kernel-related changes
base: Base system changes
package: Package manager changes
desktop: Desktop environment changes
build: Build system changes
docs: Documentation changes

Subject

Use imperative mood: "Add feature" not "Added feature"
First letter lowercase
No period at the end
Maximum 72 characters

Body (Optional)

Explain what and why, not how
Wrap at 72 characters
Can include multiple paragraphs

Footer (Optional)

Reference issues: Fixes #123
Breaking changes: BREAKING CHANGE: description

Examples

feat(kernel): add support for Btrfs filesystem

Add Btrfs filesystem support to the kernel configuration
to enable advanced features like snapshots and compression.

Fixes #45

fix(package): resolve dependency conflicts

The dependency resolver was incorrectly handling circular
dependencies. This fix implements a proper topological sort.

Closes #67

docs: update development setup guide

Add instructions for setting up Docker build environment.

Best Practices

Write clear, descriptive commit messages
Make atomic commits (one logical change per commit)
Test before committing
Review your changes with git diff
Keep commits focused and small

1.8 KiB Raw Permalink Blame History

Commit Guidelines

Commit Message Format

Types

Scope

Subject

Body (Optional)

Footer (Optional)

Examples

Best Practices

1.8 KiB

Raw Permalink Blame History