atxtechbro / atxtechbro/dotfiles

feat(procedures): document merge workflow preference

Open
#508 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
27
Forks
2
PR merge metrics
No merged PRs in 30d

Description

## Summary

Create a formal procedure documenting the preference for merge commits over squash commits in the git workflow.

## Rationale

- **Preserve commit history**: Individual commits provide valuable context for future analytics
- **Maintain granularity**: Each commit represents a distinct change with its own message and principle
- **Enable better debugging**: Can pinpoint exact commits that introduced changes
- **Support commit analytics**: Full history enables analysis of development patterns

## Procedure Details

Should document:
- Use `gh pr merge --merge --delete-branch` as standard
- Never use `--squash` unless explicitly required
- Benefits of preserving full commit history
- How this supports the versioning mindset principle

## Implementation

Add to `knowledge/procedures/git-workflow.md` or create `merge-workflow.md`

Principle: transparency-in-agent-work

Contributor guide

No contributing guide indexed for this repository

Research direction

Read knowledge/procedures/git-workflow.md first, or confirm whether a separate merge-workflow.md is more consistent with the repository. Document the preferred gh pr merge --merge --delete-branch workflow, when squash merges are allowed, and how preserving commit history supports versioning mindset and transparency-in-agent-work.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, shell
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.