📝 Add CHANGELOG.md and CODE_OF_CONDUCT.md, update README.md

elifarley · elifarley · commit 41f3ac08653e · 2025-11-28T16:56:46.000-03:00
Initial changelog documents project releases, roadmap, and migration notes for version tracking and user guidance. Code of conduct establishes community standards to foster inclusive contributions. README updates refine descriptions, section titles, and workflow examples to better highlight CedarMapper's value for code analysis and LLM integration.

🔧 Update pyproject.toml with enhanced metadata and classifiers

Enhance project description to highlight advanced CLI features for LLM-optimized repo analysis, including word counting and YAML output. Expand keywords and add classifiers for better PyPI discoverability, targeting developers, education, and various OS/platforms while emphasizing typed Python code and utility topics.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,122 @@
+# Changelog
+
+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).
+
+## [Unreleased]
+
+### Planned
+- Additional output formats (JSON, CSV)
+- Plugin system for custom analyzers
+- Integration with popular IDEs
+- Web-based repository visualization
+
+## [0.1.0] - 2025-11-28
+
+### Added
+- **Initial release** of CedarMapper CLI tool
+- **Directory traversal** with configurable depth limits
+- **Word counting** for text files using system `wc` tool
+- **Binary file detection** using `file` command with Python fallback
+- **Multiple output formats**:
+  - Flat list view with sortable columns
+  - Tree view with indentation and prefixes
+  - Tree-only mode for path listing
+  - Structured YAML output for LLM consumption
+
+- **Advanced sorting system** with 13 sort keys:
+  - Word count (`w`), Size (`s`), Date (`d`), Depth (`i`)
+  - Name (`n`), Path (`p`), File count (`f`), Directory count (`r`)
+  - Average words (`a`), Average size (`z`), Binary flag (`b`)
+  - Multi-key sorting with reverse flags (e.g., `"i-sd"`)
+
+- **Analytics columns** for comprehensive repository analysis:
+  - Node depth tracking
+  - File and directory counts per directory
+  - Average words per file (directories)
+  - Average size per file (directories)
+  - Conditional computation for performance optimization
+
+- **Performance optimizations**:
+  - Linux tool integration (`file`, `wc`, `stat`)
+  - Conditional feature computation based on displayed columns
+  - Efficient aggregation during directory traversal
+  - Safe fallbacks for non-Linux environments
+
+- **User experience features**:
+  - Git-style line limiting (`-N` syntax)
+  - Multiple date formats (ISO seconds, day-only)
+  - Numbered indentation for tree views
+  - Comprehensive CLI help and examples
+  - 55 comprehensive tests with coverage reporting
+
+- **Developer-focused features**:
+  - LLM-optimized YAML output with front matter
+  - Structured data for programmatic consumption
+  - Extensible architecture for future enhancements
+  - Type hints throughout the codebase
+  - Comprehensive documentation
+
+### Configuration
+- **PyPI package**: `cedarmapper` with entry point `cedarmapper ls`
+- **Python support**: 3.12+ with modern type annotations
+- **Dependencies**: Click (CLI framework), PyYAML (output format)
+- **Development tools**: Black, Ruff, MyPy, pytest
+- **License**: Apache 2.0
+
+### Documentation
+- Comprehensive README with 50+ usage examples
+- API documentation for all modules
+- Development setup instructions
+- Contributing guidelines
+- Security policy and code of conduct
+
+## [Future Roadmap]
+
+### Version 0.2.0 (Planned)
+- **Output formats**: JSON, CSV, Markdown table
+- **Filtering system**: File type filters, size filters, date ranges
+- **Integration**: GitHub Actions, CI/CD pipeline tools
+- **Performance**: Parallel processing for large repositories
+
+### Version 0.3.0 (Planned)
+- **Web interface**: Interactive repository visualization
+- **Comparison mode**: Before/after repository analysis
+- **Plugin system**: Custom analyzers and formatters
+- **Database export**: SQLite integration for historical data
+
+### Version 1.0.0 (Target)
+- **Stable API**: Public API for third-party integration
+- **Advanced features**: Machine learning integration for code analysis
+- **Enterprise features**: Team collaboration, reporting dashboards
+- **Ecosystem**: Integration with popular development tools
+
+---
+
+## Version Summary
+
+- **0.1.0**: Foundation release with core repository analysis capabilities
+- **0.2.0**: Enhanced output and filtering capabilities
+- **0.3.0**: Interactive features and extensibility
+- **1.0.0**: Production-ready with enterprise features
+
+## Migration Notes
+
+### From 0.1.x to 0.2.x (Future)
+- No breaking changes expected
+- New output formats will be additive
+- Existing CLI options remain stable
+- Performance improvements will be transparent
+
+### Compatibility Guarantees
+
+- **CLI interface**: Stable until 1.0.0
+- **YAML output format**: Semantic versioning for schema changes
+- **Python API**: Internal APIs may change until 1.0.0
+- **Configuration files**: Backward compatible where possible
+
+---
+
+*For detailed release notes and upgrade instructions, see the [GitHub Releases](https://github.com/yourusername/cedarmapper/releases) page.*
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,102 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+### Positive Behavior
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+* Providing help and guidance to newcomers
+* Contributing to the project in good faith
+
+### Unacceptable Behavior
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Any conduct which could reasonably be considered inappropriate in a professional setting
+* Deliberate intimidation, stalking, or following
+* Sustained disruption of discussions, talks, or other events
+* Spamming or repeatedly posting off-topic content
+
+## Project-Specific Guidelines
+
+### Code Contributions
+
+* **Quality over quantity**: Focus on meaningful contributions that improve the tool
+* **Testing**: Ensure all contributions include appropriate tests
+* **Documentation**: Update documentation for new features and changes
+* **Performance**: Consider performance implications, especially for large repositories
+* **Compatibility**: Maintain backward compatibility when possible
+
+### Issue Reporting and Discussions
+
+* **Search first**: Check existing issues before creating new ones
+* **Be specific**: Provide clear, detailed descriptions of problems or suggestions
+* **Code examples**: Include minimal reproducible examples when reporting bugs
+* **Patience**: Maintainers are volunteers and will respond as time permits
+
+## Responsibilities
+
+### Project Maintainers
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+### Contributors
+
+Contributors are expected to:
+
+* Read and follow this Code of Conduct
+* Help create a positive and inclusive environment
+* Report inappropriate behavior to maintainers
+* Focus on what is best for the community
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+### Reporting Incidents
+
+If you experience or witness unacceptable behavior, please contact the project team:
+
+**Email**: conduct@example.com
+
+All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+### Enforcement Process
+
+1. **Report**: Any community member can report violations to the project team
+2. **Review**: Maintainers will review the report privately and objectively
+3. **Action**: If the Code of Conduct was violated, appropriate action will be taken
+4. **Follow-up**: Maintainers may follow up with involved parties as needed
+
+### Possible Consequences
+
+Consequences for violating the Code of Conduct may include:
+
+* Private warning from the project team
+* Temporary or permanent ban from public project spaces
+* Removal of access to project resources
+* Public statement about the violation (with consent of the reporter)
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 [![Python](https://img.shields.io/badge/python-%E2%89%A53.12-blue.svg)](https://python.org)
 [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-Ultra-fast directory traversal with word counting, statistical analysis, and structured output designed specifically for LLM workflows and code repository understanding.
+CedarMapper is a powerful CLI tool for **code analysis** and **repository visualization** that generates comprehensive **project analytics** for **LLM** consumption. Perfect for **developer tools** workflows, this **directory analysis** solution provides **code statistics** and **code overview** capabilities with multi-key sorting and structured YAML output.
 
-## ✨ Key Features
+## ✨ Key Features: Repository Analysis & Code Statistics
 
 - **🎯 Structured YAML Output** with front matter for programmatic consumption
 - **📊 Advanced Analytics Columns**: node depth, file/directory counts, average statistics
@@ -16,7 +16,7 @@ Ultra-fast directory traversal with word counting, statistical analysis, and str
 - **🌳 Rich Tree Views**: numbered indentation and prefix separation
 - **🔍 Binary File Detection**: intelligent content analysis and caching
 
-## 🚀 Quick Start
+## 🚀 Quick Start: CLI Tool Installation & Usage
 
 ### Installation
 
@@ -43,7 +43,7 @@ cedarmapper ls . --sort "-sf" --max-depth 3
 cedarmapper ls . -10 --sort "-s"
 ```
 
-## 🎯 Structured YAML Output
+## 🎯 Structured YAML Output: LLM-Optimized Data Format
 
 Generate machine-readable repository analysis with comprehensive metadata:
 
@@ -103,7 +103,7 @@ entries:
 - CI/CD pipeline integration
 - Code review automation
 
-## 📊 Advanced Analytics Columns
+## 📊 Advanced Analytics: Project Statistics & Directory Analysis
 
 Display comprehensive statistics about your repository structure:
 
@@ -195,7 +195,7 @@ Words         Size            Modified Path
   94294     14947634 2025-11-28T15:25:22 TOTAL
 ```
 
-## ⚡ Performance Features
+## ⚡ Performance Features: High-Speed Directory Analysis
 
 ### Linux Tool Integration
 CedarMapper automatically leverages Linux tools for maximum performance:
@@ -222,7 +222,7 @@ cedarmapper ls . --show-word-count
 cedarmapper ls src/ --max-depth 2 --file-count --dir-count
 ```
 
-## 🔧 Practical Workflows
+## 🔧 Practical Workflows: Real-World Developer Tools Usage
 
 ### Repository Overview for LLMs
 ```bash
@@ -266,7 +266,7 @@ cedarmapper ls . --sort "-f" --max-depth 3
 cedarmapper ls . --sort "z" --avg-size --max-depth 2
 ```
 
-## 📊 Feature Comparison
+## 📊 Feature Comparison: CedarMapper vs Other Code Analysis Tools
 
 | Feature | CedarMapper | `tree` | `fd/find` | `llm-repo-tools` |
 |---------|-------------|--------|-----------|------------------|
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,24 +5,37 @@ build-backend = "hatchling.build"
 [project]
 name = "cedarmapper"
 version = "0.1.0"
-description = "Tool to help LLMs get overviews of large repos at desired granularity levels"
+description = "Advanced CLI tool for LLM-optimized repository analysis with word counting, multi-key sorting, and structured YAML output. Perfect for AI-powered code analysis and project overview generation."
 readme = "README.md"
 requires-python = ">=3.12"
 license = {text = "Apache-2.0"}
 authors = [
     {name = "Your Name", email = "your.email@example.com"}
 ]
-keywords = ["llm", "repository", "analysis", "code-overview"]
+keywords = ["cli-tool", "code-analysis", "project-analytics", "developer-tools", "code-overview", "directory-analysis", "llm-tool", "code-statistics", "repository-visualization"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Console",
     "Intended Audience :: Developers",
+    "Intended Audience :: Education",
     "License :: OSI Approved :: Apache Software License",
     "Operating System :: OS Independent",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
-    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Software Development :: Tools",
+    "Topic :: System :: Archiving",
+    "Topic :: System :: Filesystems",
+    "Topic :: System :: Monitoring",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Text Processing",
+    "Topic :: Utilities",
+    "Typing :: Typed",
 ]
 dependencies = [
     "click>=8.0.0",
