Files

T

Noah Brier f609668172 Initial commit - Claudesidian v0.2.0

Claude Code + Obsidian starter kit for AI-powered knowledge management.

Features:
- PARA method folder structure
- Bootstrap initialization system
- Pre-configured Claude Code commands and agents
- Gemini Vision MCP server with video support
- Helper scripts for vault management
- Automated release management

See README.md for setup instructions.

2025-09-13 12:20:50 -04:00

2.2 KiB

Raw Blame History

Contributing to Claudesidian

Thank you for your interest in contributing to claudesidian! This document provides guidelines for contributing to the project.

Development Setup

Fork the repository
Clone your fork: git clone https://github.com/yourusername/claudesidian.git
Install dependencies: pnpm install
Create a feature branch: git checkout -b feature/your-feature-name

Commit Message Convention

We follow Conventional Commits for clear commit history:

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

Examples:

feat: add new research-assistant command
fix: correct attachment link updates in scripts
docs: update README with MCP setup instructions

Versioning

We use Semantic Versioning:

MAJOR (1.0.0): Breaking changes
MINOR (0.1.0): New features (backward compatible)
PATCH (0.0.1): Bug fixes (backward compatible)

Pull Request Process

Update the CHANGELOG.md with your changes under "Unreleased"
Update documentation if needed
Ensure all scripts still work
Submit PR with clear description of changes

Changelog Updates

When contributing, add your changes to CHANGELOG.md under the "Unreleased" section:

## [Unreleased]

### Added
- Your new feature here

### Fixed
- Your bug fix here

Use these categories:

Added - New features
Changed - Changes to existing functionality
Deprecated - Features to be removed
Removed - Removed features
Fixed - Bug fixes
Security - Security updates

Release Process (Maintainers)

Update version in package.json
Move "Unreleased" items to new version in CHANGELOG.md
Commit: git commit -m "chore: release v0.2.0"
Tag: git tag v0.2.0
Push: git push && git push --tags
Create GitHub Release from tag, using changelog content

Code Style

Use clear, descriptive variable names
Comment complex logic
Keep functions focused and small
Test your changes thoroughly

Questions?

Feel free to open an issue for discussion before making large changes.

2.2 KiB Raw Blame History