Conversation
…d releases Add comprehensive documentation and templates to enforce squash merge workflow and conventional commits, fixing semantic-release integration. Changes: - Add .github/pull_request_template.md: Guide contributors to provide conventional commit message in PR description for squash merge - Add .github/CONTRIBUTING.md: Complete contributing guide covering development setup, PR process, conventional commits, code style, testing, and feature development workflow - Add .github/SQUASH_MERGE.md: Repository configuration instructions for maintainers to enable squash merge only via GitHub settings or CLI - Update README.md: Add contributing section linking to new documentation and emphasizing squash merge requirement - Update tracking/documentation.md: Document this configuration work Problem Solved: Previous PR #13 merge commit "Fix/security patches (#13)" didn't follow conventional commit format, causing semantic-release to skip release. Squash merge ensures single commit per PR with proper format. Benefits: - Clean git history (one commit per feature/fix) - Automatic semantic versioning from commit messages - Proper changelog generation via semantic-release - Easy rollbacks with single commit per feature - Consistent commit format enforcement Configuration Required: Repository maintainer must configure GitHub settings to disable merge commits and rebase merging, enable squash merge only. Instructions provided in .github/SQUASH_MERGE.md. Refs: #13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of Change
feat: New feature or enhancementfix: Bug fixperf: Performance improvementrefactor: Code refactoringdocs: Documentation updatestest: Test additions or updatesbuild: Build system or dependency changesci: CI/CD configuration changeschore: Maintenance tasksScope
Scope:
Breaking Changes
Breaking change description (if applicable):
Commit Message
Suggested commit message:
Checklist
## [Unreleased]section (if user-facing change)features/(if new feature)examples/(if new YAML kind or CLI feature)Related Issues
Closes: #
Refs: #
Additional Context