Skip to content

Conversation

@dguido
Copy link
Member

@dguido dguido commented Nov 28, 2025

Summary

Documentation updates and minor file formatting fixes (trailing newlines).

Documentation Changes

README.md

  • Add uv as recommended package manager
  • Update installation instructions with modern options
  • Minor clarifications

CONTRIBUTING.md

  • Add ruff linting setup instructions
  • Add pre-commit hooks setup
  • Update development workflow for modern tooling

docs/

  • Minor fixes in Code-Similarity-Detector.md
  • Tutorial README updates

GitHub Templates

  • Issue templates: YAML formatting consistency
  • Discussion templates: YAML formatting fixes
  • dependabot.yml: Configuration updates

File Formatting (non-functional)

  • examples/*.sol - Add missing trailing newlines
  • examples/*.dot - Add missing trailing newlines
  • CITATION.cff - Minor formatting

Why These Changes?

  1. Documentation needs to reflect modern tooling (uv, ruff)
  2. Linters flag missing trailing newlines
  3. YAML templates had inconsistent formatting

Independent PR

This PR has no dependencies and can be merged independently of the other modernization PRs.

Part of

PR Title Link
Build system migration #2818
Replace linters with ruff #2819
CI modernization #2820
Documentation & cleanup This PR

🤖 Generated with Claude Code

## Documentation Updates
- README.md: Add uv installation instructions, update badges
- CONTRIBUTING.md: Add ruff/pre-commit setup, modern dev workflow
- docs/: Minor fixes and updates

## GitHub Templates
- Issue templates: YAML formatting fixes
- Discussion templates: YAML formatting fixes
- dependabot.yml: Updated configuration

## File Formatting
- examples/*.sol: Add missing trailing newlines
- examples/*.dot: Add missing trailing newlines
- CITATION.cff: Minor updates

These are non-functional changes that improve documentation
and fix linting warnings for trailing newlines.

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

Co-Authored-By: Claude <[email protected]>
@dguido dguido requested a review from smonicas as a code owner November 28, 2025 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants