Comprehensive Template Modernization - CI/CD, Modern Python Tooling, and Best Practices #2

silvexis · 2025-11-17T17:27:25Z

What's in this PR:

14 commits with all improvements
27 files changed (15 new, 12 modified)
+1,438 lines, -61 lines
Major Additions:
4 GitHub Actions workflows (Python CI, JavaScript CI, CodeQL, Dependabot)
3 Docker files (Dockerfile, .dockerignore, docker-compose.yml)
3 YAML issue forms (bug report, feature request, config)
1 Makefile with 10+ common tasks
1 SECURITY.md for vulnerability reporting
1 NOTICE file for Apache 2.0 compliance
Complete pyproject.toml, package.json, CONTRIBUTING.md updates
Modernizations:
Python 3.11+ with uv and Ruff
60% test coverage minimum
Library recommendations (polars, httpx, pydantic, aws-lambda-powertools)
All copyright updated to "All Rights Reserved"

Replace [INSERT CONTACT METHOD] with community@cloudzero.com for reporting Code of Conduct violations. This completes the template and provides a clear contact point for community enforcement issues.

Change all references from README-sample.md to README-template.md to match the actual filename in the repository. This ensures users can correctly locate and use the template file.

Replace external Auth0 repository links with relative paths to CloudZero's contribution guidelines and code of conduct. This ensures the template is self-contained and works correctly when forked.

Add security policy file with guidelines for reporting security vulnerabilities. Directs reporters to security@cloudzero.com and provides template for what information to include in reports.

Remove the year (2023) from the copyright notice as years are no longer required in copyright statements and removing them reduces maintenance overhead.

- Update minimum Python version to 3.11 - Add support for Python 3.11, 3.12, 3.13 - Add build-system configuration (PEP 517/518) - Add project.urls for better package metadata - Add optional-dependencies for dev, test, and lint - Add tool configurations for pytest, coverage, black, ruff, and mypy - Set modern linting and formatting standards

Replace placeholder text with detailed contribution guidelines including: - Complete environment setup instructions for Python and JavaScript - Comprehensive testing guidelines and coverage requirements - Code quality tools configuration (Black, Ruff, mypy, ESLint, Prettier) - Code style guidelines and commit message conventions - CI/CD information and how to pass checks - Detailed PR guidelines and review process - Pre-commit hooks setup - Assets compilation instructions Also fix outdated GitHub link to use relative path.

- Remove Black from all dependencies and tool configurations - Add Ruff formatter configuration to replace Black - Switch from pip/venv to uv for Python package management - Update all Python commands to use uv (uv run, uv sync, uv build) - Add data dependencies with pandas (preferred over polars) - Update CONTRIBUTING.md with uv installation and usage instructions - Document that pandas is preferred for data projects Benefits: - Ruff handles both linting and formatting (single tool) - uv provides faster package resolution and installation - Consistent tooling recommendations across projects

Add optional dependencies and documentation for preferred libraries: - httpx for HTTP clients (prefer over requests) - pydantic 2 for data validation - aws-lambda-powertools for AWS Lambda projects - pandas for data manipulation (already documented) These recommendations ensure consistency across CloudZero projects and promote modern, well-maintained libraries with better performance and type safety.

Change preferred data manipulation library from pandas to polars: - Update pyproject.toml data dependency to polars>=0.20.0 - Update CONTRIBUTING.md to recommend polars over pandas Polars provides better performance and a more modern API for data manipulation tasks.

Remove mypy from all configurations as it's not part of the recommended tooling stack: - Remove from dev and lint optional dependencies - Remove from uv dev-dependencies - Remove [tool.mypy] configuration section - Remove type checking instructions from CONTRIBUTING.md - Remove type checking from CI/CD pipeline description Projects can still use type hints without mypy enforcement. Ruff provides basic type checking through its linting rules.

Add GitHub Actions workflows: - Python CI with uv, Ruff formatting/linting, pytest with 60% coverage - JavaScript CI with npm, Prettier, ESLint, Jest with 60% coverage - CodeQL security scanning for Python and JavaScript - Dependabot auto-merge for approved PRs Update configuration files: - .gitignore: Add uv, Ruff, Node.js, macOS, Rust entries; update copyright - CHANGELOG.md: Add Keep a Changelog template with semantic versioning - CODEOWNERS: Expand to @cloudzero/open-source-maintainers with detailed patterns - package.json: Add engines, scripts, devDependencies, bugs/homepage URLs - .npmignore: Add actual content for excluding dev files from npm packages All changes support modern development workflows and best practices.

Add GitHub Issue Forms: - YAML-based bug report and feature request templates - Issue template config with support links - Improved structure and validation Add Release Management: - release.yml for automated changelog categorization - Labels configuration for consistent issue/PR labeling - Categories for features, bugs, docs, maintenance, security Add Docker Support: - Multi-stage Dockerfile using uv for Python applications - .dockerignore for efficient builds - docker-compose.yml with development setup Add Project Tooling: - Makefile with common development tasks - Support for install, test, lint, format, build, docker commands - Clean targets for artifact removal Add Legal/Compliance: - NOTICE file with copyright and third-party attributions - Updated LICENSE copyright to include "All Rights Reserved" - Consistent copyright notices across project Update Configuration: - pyproject.toml: Add 60% minimum coverage requirement - dependabot.yaml: Add npm ecosystem support All additions support modern open source best practices and streamline development workflows.

greptile-apps · 2025-11-17T17:30:06Z

Greptile Summary

Comprehensive template modernization adding CI/CD workflows, Docker support, modern Python/JS tooling, and extensive documentation
Critical path inconsistency: CI workflows, Dockerfile, and Makefile assume root-level project structure but template uses python/ and javascript/ subdirectories
Test coverage requirements inconsistent across CONTRIBUTING.md (80%), pyproject.toml (60%), and CI workflow (60%)

Confidence Score: 3/5

This PR has path mismatch issues that will cause CI/CD failures and build errors
Score reflects multiple critical path inconsistencies between new infrastructure files and existing template structure. CI workflows will fail immediately due to incorrect working directories. While the individual components are well-designed, the integration issues require fixes before merge.
Pay close attention to .github/workflows/ci-python.yml, .github/workflows/ci-javascript.yml, Dockerfile, .github/dependabot.yaml, and Makefile - all have path mismatches with the template's subdirectory structure

Important Files Changed

Filename	Overview
.github/workflows/ci-python.yml	Adds Python CI workflow but assumes `pyproject.toml` at repo root, while template structure has it in `python/` subdirectory
.github/workflows/ci-javascript.yml	Adds JavaScript CI workflow but assumes `package.json` at repo root, while template structure has it in `javascript/` subdirectory
Dockerfile	Adds multi-stage Docker build but assumes `pyproject.toml` at repo root, inconsistent with template's `python/` subdirectory structure
Makefile	Adds Python-focused Makefile that assumes root-level Python project, doesn't account for `python/` subdirectory structure
.github/dependabot.yaml	Configures Dependabot for pip at root but Python files are in `python/` subdirectory; JavaScript config correctly points to `javascript/`

greptile-apps

Additional Comments (1)

.github/dependabot.yaml, line 12-13 (link)

logic: pip ecosystem configured for root / but Python files are in python/ subdirectory. JavaScript correctly uses /javascript

_{27 files reviewed, 6 comments}

_{Edit Code Review Agent Settings | Greptile}
_{React with 👍 or 👎 to share your feedback on this new summary format}

greptile-apps · 2025-11-17T17:30:02Z

.github/workflows/ci-python.yml

+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync --extra dev


logic: workflow assumes pyproject.toml at repo root, but template has it in python/ subdirectory. Add working-directory: python or adjust paths

greptile-apps · 2025-11-17T17:30:03Z

.github/workflows/ci-javascript.yml

+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci


logic: workflow assumes package.json at repo root, but template has it in javascript/ subdirectory. Add working-directory: javascript or adjust npm commands

greptile-apps · 2025-11-17T17:30:03Z

Dockerfile

+# Copy dependency files
+COPY pyproject.toml ./


logic: copies pyproject.toml from root but template structure has it in python/ subdirectory. Adjust paths or document expected structure

Suggested change

# Copy dependency files

COPY pyproject.toml ./

COPY python/pyproject.toml ./pyproject.toml

COPY python/README.md ./README.md

greptile-apps · 2025-11-17T17:30:05Z

Makefile

+
+# Python: Install production dependencies
+install:
+	uv sync


style: Makefile assumes Python project at root level but template has python/ subdirectory. Consider adding targets that work from root or document structure

greptile-apps · 2025-11-17T17:30:05Z

CONTRIBUTING.md

+- New code should have at least 80% test coverage
+- Critical paths should have 100% coverage


logic: test coverage requirement is 80% here but pyproject.toml sets fail_under = 60 and CI workflow uses --cov-fail-under=60. Align these requirements

claude added 14 commits November 14, 2025 16:49

fix: Replace placeholder contact method in CODE-OF-CONDUCT.md

347fa53

Replace [INSERT CONTACT METHOD] with community@cloudzero.com for reporting Code of Conduct violations. This completes the template and provides a clear contact point for community enforcement issues.

fix: Update README to reference correct filename README-template.md

7468f49

Change all references from README-sample.md to README-template.md to match the actual filename in the repository. This ensures users can correctly locate and use the template file.

fix: Update Auth0 links to CloudZero with relative paths

67b5eea

Replace external Auth0 repository links with relative paths to CloudZero's contribution guidelines and code of conduct. This ensures the template is self-contained and works correctly when forked.

feat: Add SECURITY.md for vulnerability reporting

cd31ccc

Add security policy file with guidelines for reporting security vulnerabilities. Directs reporters to security@cloudzero.com and provides template for what information to include in reports.

fix: Remove year from copyright notice in LICENSE

d065393

Remove the year (2023) from the copyright notice as years are no longer required in copyright statements and removing them reduces maintenance overhead.

feat: Add .dockerignore for efficient Docker builds

65ae08c

silvexis merged commit ab35543 into main Nov 17, 2025
1 of 9 checks passed

silvexis deleted the claude/code-review-template-01UXFbM5TpFwUntpvX5dxSxg branch November 17, 2025 17:28

greptile-apps bot reviewed Nov 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comprehensive Template Modernization - CI/CD, Modern Python Tooling, and Best Practices #2

Comprehensive Template Modernization - CI/CD, Modern Python Tooling, and Best Practices #2

Uh oh!

silvexis commented Nov 17, 2025

Uh oh!

Uh oh!

greptile-apps bot commented Nov 17, 2025

Uh oh!

greptile-apps bot left a comment •

edited

Loading

Uh oh!

greptile-apps bot Nov 17, 2025

Uh oh!

greptile-apps bot Nov 17, 2025

Uh oh!

greptile-apps bot Nov 17, 2025

Uh oh!

greptile-apps bot Nov 17, 2025

Uh oh!

greptile-apps bot Nov 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		- New code should have at least 80% test coverage
		- Critical paths should have 100% coverage

Comprehensive Template Modernization - CI/CD, Modern Python Tooling, and Best Practices #2

Comprehensive Template Modernization - CI/CD, Modern Python Tooling, and Best Practices #2

Uh oh!

Conversation

silvexis commented Nov 17, 2025

Uh oh!

Uh oh!

greptile-apps bot commented Nov 17, 2025

Greptile Summary

Confidence Score: 3/5

Important Files Changed

Uh oh!

greptile-apps bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Additional Comments (1)

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

greptile-apps bot left a comment •

edited

Loading