Instruction file imported from dipievil/easy-ssh-mob (.github/instructions/git-pattern.instructions.md). Copyright stays with the author.

Commits

• Use clear and descriptive commit messages
• Use the pattern type: description (e.g., feat: add new feature)
• Use fix: for bug fixes
• Use docs: for documentation changes
• Use style: for formatting and style (no logic changes)
• Use refactor: for code refactoring
• Use test: for adding or modifying tests
• Use chore: for maintenance tasks (e.g., dependency updates)
• Use ci: for CI/CD configuration changes
• Use perf: for performance improvements
• Use build: for build system changes
• Use revert: to revert previous commits
• Use WIP: to indicate work in progress
• Use TODO: to indicate pending tasks
• Use changelog: to indicate changes that should be reflected in the changelog

Branches

• Use descriptive names for branches
• Use the pattern type/descriptive-name (e.g., feature/new-functionality)
• Use bugfix/ for bug fixes
• Use hotfix/ for urgent fixes
• Use release/ for release branches
• Use experiment/ for experimental branches
• Use chore/ for maintenance tasks
• Use docs/ for documentation changes
• Use test/ for test branches

Pull Requests

• Use clear and descriptive titles
• Use detailed descriptions explaining the changes
• Use labels to categorize PRs (e.g., feature, bugfix, documentation)
• Use reviewers to ensure code quality
• Use comments to explain design decisions or complex logic
• Use WIP to indicate the PR is still in progress

Issues

• Use clear and descriptive titles
• Use detailed descriptions explaining the problem
• Use labels to categorize issues (e.g., bug, feature, documentation)
• Use assignees to indicate responsible parties
• Use milestones to group related issues
• Use comments to discuss solutions or clarify doubts
• Use TODO to indicate pending tasks

Tags

• Use tags to mark important code versions
• Use the pattern vX.Y.Z (e.g., v1.0.0)
• Use latest for the most recent version
• Use stable for stable versions
• Use beta for beta versions
• Use alpha for alpha versions
• Use rc for release candidates