Skip to content

docs: Add CONTRIBUTING.md and fix README badges - #14

Merged
db-tycoon-stephen merged 3 commits into
v0.2from
docs/contributing-and-workflow
Jan 2, 2026
Merged

docs: Add CONTRIBUTING.md and fix README badges#14
db-tycoon-stephen merged 3 commits into
v0.2from
docs/contributing-and-workflow

Conversation

@db-tycoon-stephen

Copy link
Copy Markdown
Contributor

Summary

Documents the workflow norms and branch strategy we've established:

Changes

  1. CONTRIBUTING.md - New file documenting:

    • Branch strategy (feature → release → main)
    • Protected branches (main, v0.x)
    • CI requirements
    • Commit message conventions
    • PR guidelines
    • Release process
  2. README.md - Fixed badges:

    • Updated to point to actual workflows (ci.yml, release.yml)
    • Fixed repo name case (SnowTower)

Branch Protection Added

Also added branch protection to v0.2 via API:

  • Require PR with 1 approval
  • Require CI to pass (Lint & Format Check, Run Tests)
  • Enforce for admins
  • Require linear history
  • Block force pushes

Change Type

  • Documentation

Checklist

  • Pre-commit checks pass
  • No secrets or sensitive data included

- Add CONTRIBUTING.md documenting branch strategy and workflow norms
- Fix README badges to point to actual CI workflows (ci.yml, release.yml)
- Document protected branches (main, v0.x release branches)
- Document PR requirements and commit conventions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Dec 23, 2025
db-tycoon-stephen and others added 2 commits December 29, 2025 07:10
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Replace outdated pr-validation.yml and deploy-production.yml references
- Document actual workflows: ci.yml, release.yml, labeler.yml, changelog.yml
- Add simplified mermaid diagram showing actual CI flow
- Document commit message conventions for changelog generation
- Add troubleshooting section for common CI failures
- Reference CONTRIBUTING.md for detailed guidelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@db-tycoon-stephen
db-tycoon-stephen merged commit fb19e0b into v0.2 Jan 2, 2026
3 checks passed
@db-tycoon-stephen
db-tycoon-stephen deleted the docs/contributing-and-workflow branch January 2, 2026 23:08
db-tycoon-stephen added a commit that referenced this pull request Jan 2, 2026
* docs: Add v0.2 release proposal for CI/CD features

* feat: Add CI/CD workflows and PR template (#9)

* feat: Add CI/CD workflows and PR template

- Add GitHub Actions CI workflow for pytest and pre-commit
- Add PR template with checklist and sections
- Add auto-labeling workflow based on changed files
- Add labeler configuration for file-to-label mapping

Implements #2, #4, #5

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: Auto-fix linting instead of failing CI

- Black runs without --check (auto-formats)
- Ruff runs with --fix (auto-fixes)
- Uses git-auto-commit-action to commit fixes
- Tests run after lint job completes
- Added v0.2 branch to CI triggers

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: Use pre-commit for validation, remove auto-fix

CI validates that pre-commit passes. Developers should run
pre-commit locally to fix issues before committing.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* style: Apply pre-commit formatting fixes

- Fix trailing whitespace
- Fix end of file newlines
- Apply Black formatting

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>

* feat: Add issue template, changelog, and release workflows (#11)

- Add new-user-request issue template (#6)
- Add changelog generation workflow (#7)
- Add release workflow with validation (#8)
- Remove business-specific schema configs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>

* feat: Add snowtower-maintainer Claude Code skill (#13)

Creates a specialized skill for maintaining SnowTower project:
- README maintenance and statistics updates
- .claude folder organization and agent auditing
- Documentation sync procedures
- Self-maintenance capabilities

Includes PROJECT_STRUCTURE.md reference document.

Closes #12

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>

* docs: Add CONTRIBUTING.md and fix README badges (#14)

* docs: Add CONTRIBUTING.md and fix README badges

- Add CONTRIBUTING.md documenting branch strategy and workflow norms
- Fix README badges to point to actual CI workflows (ci.yml, release.yml)
- Document protected branches (main, v0.x release branches)
- Document PR requirements and commit conventions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: Document automatic v* ruleset protection

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: Update CI/CD section to reflect actual workflows

- Replace outdated pr-validation.yml and deploy-production.yml references
- Document actual workflows: ci.yml, release.yml, labeler.yml, changelog.yml
- Add simplified mermaid diagram showing actual CI flow
- Document commit message conventions for changelog generation
- Add troubleshooting section for common CI failures
- Reference CONTRIBUTING.md for detailed guidelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>

* feat: Add Claude skills and remove redundant agents (#15)

## Changes

### Added
- snowtower-user skill: End-user guide for requesting access and connecting
- snowtower-admin skill: Admin guide for SnowDDL operations and troubleshooting

### Removed
- 24 redundant agent files from .claude/agents/
- CONSOLIDATION_SUMMARY.md (no longer needed)

### Changed
- Bumped version to 0.2.0
- Renamed docs/agents/ to docs/llm-context/
- Updated README to reference skills instead of agents
- Updated CLAUDE.md with new paths

### Skills Overview
| Skill | Purpose |
|-------|---------|
| snowtower-user | End-users requesting access |
| snowtower-admin | Infrastructure administrators |
| snowtower-maintainer | Project/docs maintenance |

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>

* chore: Final polish for v0.2 release (#17)

## Changes

### Documentation
- Fix docs/README.md broken links (agents/ → llm-context/)
- Remove stale planning docs (NEXT_STEPS_SCHEMA_DRIFT.md, SCHEMA_DRIFT_ELIMINATION_PLAN.md)
- Add v0.2 release notes
- Add v0.3 roadmap with deferred features
- Update docs index with v0.2 and v0.3 links

### Pre-commit
- Update pre-commit-hooks to v5.0.0
- Update Black to 24.4.2 (Python 3.12.5 compatible)
- Apply Black formatting to 18 files

### Code Style
- Black formatting applied consistently across codebase

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant