@chongdashu/cc-statusline 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2025-08-13
+
+### Added
+- CONTRIBUTING.md with comprehensive contribution guidelines
+- Development workflow documentation
+- Code standards and testing guidelines
+
+### Changed
+- Updated package name to unscoped `cc-statusline`
+- Enhanced README contributing section with better guidance
+
 ## [1.0.0] - 2025-08-13
 
 ### Added

package/CONTRIBUTING.md

@@ -0,0 +1,208 @@
+# Contributing to cc-statusline
+
+Thank you for your interest in contributing to cc-statusline! This document provides guidelines and information for contributors.
+
+## 🚀 Quick Start
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR-USERNAME/cc-statusline.git
+   cd cc-statusline
+   ```
+3. **Install dependencies**:
+   ```bash
+   npm install
+   ```
+4. **Build the project**:
+   ```bash
+   npm run build
+   ```
+5. **Test your changes**:
+   ```bash
+   ./dist/index.js --help
+   npx . init --no-install  # Test locally
+   ```
+
+## 🛠️ Development Workflow
+
+### Making Changes
+
+1. **Create a feature branch**:
+   ```bash
+   git checkout -b feature/amazing-feature
+   ```
+
+2. **Make your changes** following our coding standards
+
+3. **Test your changes**:
+   ```bash
+   npm run build
+   ./dist/index.js preview path/to/statusline.sh
+   ```
+
+4. **Commit your changes**:
+   ```bash
+   git add .
+   git commit -m "feat: add amazing feature"
+   ```
+
+### Commit Message Format
+
+We follow [Conventional Commits](https://conventionalcommits.org/):
+
+- `feat:` - New features
+- `fix:` - Bug fixes
+- `docs:` - Documentation changes
+- `style:` - Code style changes (formatting, etc.)
+- `refactor:` - Code refactoring
+- `test:` - Adding tests
+- `chore:` - Maintenance tasks
+
+Examples:
+```
+feat: add support for Python runtime
+fix: resolve preview timeout issue
+docs: update README installation guide
+```
+
+## 🎯 Types of Contributions
+
+### 🐛 Bug Reports
+- Use GitHub Issues with the bug template
+- Include steps to reproduce
+- Provide sample statusline.sh if relevant
+- Include OS and Node.js version
+
+### ✨ Feature Requests
+- Use GitHub Issues with the feature template
+- Explain the use case
+- Consider implementation complexity
+- Check if it fits the "dead simple" philosophy
+
+### 🔧 Code Contributions
+- **New Features**: Discuss in an issue first
+- **Bug Fixes**: Can be submitted directly
+- **Documentation**: Always welcome!
+
+## 📋 Code Standards
+
+### TypeScript
+- **Strict typing** - All functions must have type hints
+- **ESM modules** - Use import/export syntax
+- **Error handling** - Always handle errors gracefully
+
+### Code Style
+- **2 spaces** for indentation
+- **No semicolons** (follows project style)
+- **Descriptive names** - Functions and variables should be self-documenting
+- **Comments** - Only when necessary to explain "why", not "what"
+
+### File Structure
+```
+src/
+├── cli/           # CLI commands and prompts
+├── features/      # Feature-specific code (git, usage, colors)
+├── generators/    # Script generators (bash, etc.)
+└── utils/         # Utilities (installer, validator, tester)
+```
+
+## 🧪 Testing
+
+### Manual Testing
+```bash
+# Build and test CLI
+npm run build
+./dist/index.js init --output ./test-statusline.sh --no-install
+
+# Test preview functionality
+./dist/index.js preview ./test-statusline.sh
+
+# Test with different configurations
+# (Change features in prompts.ts and rebuild)
+```
+
+### Adding Tests
+- Test new features in `src/utils/tester.ts`
+- Ensure backwards compatibility
+- Test error conditions
+
+## 📚 Documentation
+
+### README Updates
+- Keep examples current
+- Update command usage if changed
+- Maintain consistent formatting
+
+### Code Documentation
+- Update JSDoc comments for new functions
+- Include parameter and return types
+- Provide usage examples for complex functions
+
+## 🚢 Pull Request Process
+
+1. **Update documentation** if needed
+2. **Test your changes** thoroughly
+3. **Update CHANGELOG.md** following Keep a Changelog format
+4. **Submit pull request** with clear description
+5. **Address review feedback** promptly
+
+### Pull Request Template
+```markdown
+## Description
+Brief description of changes
+
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Refactoring
+
+## Testing
+- [ ] Tested locally
+- [ ] Updated tests if needed
+- [ ] Documentation updated
+
+## Checklist
+- [ ] Follows code style
+- [ ] Self-review completed
+- [ ] CHANGELOG.md updated
+```
+
+## 🤝 Community Guidelines
+
+### Be Respectful
+- Use welcoming and inclusive language
+- Respect different viewpoints and experiences
+- Focus on constructive feedback
+
+### Be Helpful
+- Help newcomers get started
+- Share knowledge and best practices
+- Collaborate openly
+
+### Keep It Simple
+- Follow the "dead simple" philosophy
+- Avoid over-engineering
+- Prioritize user experience
+
+## 🏆 Recognition
+
+Contributors will be:
+- Listed in CHANGELOG.md for their contributions
+- Mentioned in release notes for significant features
+- Welcomed into the community with appreciation
+
+## ❓ Questions?
+
+- **GitHub Issues** - For bugs and feature requests
+- **GitHub Discussions** - For questions and ideas
+- **Email** - chong-u@aioriented.dev for private matters
+
+## 📜 License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+---
+
+**Thank you for helping make cc-statusline better!** 🚀

package/README.md

@@ -185,13 +185,14 @@ npm run dev
 
 ## Contributing
 
-Contributions welcome! Please read our [Contributing Guide](CONTRIBUTING.md).
+Contributions welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for detailed information on:
 
-1. Fork the repository
-2. Create feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit changes (`git commit -m 'Add amazing feature'`)
-4. Push to branch (`git push origin feature/amazing-feature`)  
-5. Open Pull Request
+- Setting up the development environment
+- Code standards and conventions  
+- Testing your changes
+- Submitting pull requests
+
+Quick start: Fork → Clone → `npm install` → Make changes → Test → Submit PR
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chongdashu/cc-statusline",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Interactive CLI tool for generating custom Claude Code statuslines",
   "type": "module",
   "main": "dist/index.js",