Skip to content

Conversation

@brunopgalvao
Copy link
Collaborator

Summary

  • Simplified CONTRIBUTING.md setup instructions to be truly CLI-first
  • Streamlined documentation and messaging across templates and recipes
  • Improved consistency in codebase comments and user-facing descriptions

Changes

  • Updated CONTRIBUTING.md to remove manual fork/clone steps - users only need to download the CLI binary
  • Refactored documentation templates for clarity
  • Updated recipe descriptions and metadata for consistency
  • Simplified code comments and user-facing messages

Testing

  • Pre-commit checks passed
  • Documentation reviewed for clarity

Update CONTRIBUTING.md to simplify setup instructions and adopt a CLI-first approach. Refactor documentation and messaging across templates, recipes, and codebase for consistency and clarity.
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

✅ Coverage Report

Core Library Coverage: 90.85% (threshold: 80%)
Workspace Coverage: 66.43% (informational)

Core library coverage details
Filename                      Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
config/mod.rs                      37                 2    94.59%          16                 1    93.75%         104                 4    96.15%           0                 0         -
config/recipe.rs                   60                18    70.00%          12                 2    83.33%         134                10    92.54%           0                 0         -
config/validation.rs              151                 9    94.04%          24                 1    95.83%         256                16    93.75%           0                 0         -
error.rs                           17                 5    70.59%           8                 3    62.50%          35                 9    74.29%           0                 0         -
git/mod.rs                        165                40    75.76%          43                 9    79.07%         408                43    89.46%           0                 0         -
scaffold/bootstrap.rs             160                73    54.37%          31                11    64.52%         378                87    76.98%           0                 0         -
scaffold/mod.rs                   320                75    76.56%          55                 7    87.27%         760                68    91.05%           0                 0         -
templates/justfile.rs               8                 1    87.50%           5                 1    80.00%          26                 3    88.46%           0                 0         -
templates/mod.rs                    1                 1     0.00%           1                 1     0.00%          14                14     0.00%           0                 0         -
templates/readme.rs                16                 0   100.00%           5                 0   100.00%          84                 0   100.00%           0                 0         -
templates/recipe_yml.rs            21                 3    85.71%           4                 0   100.00%          64                 3    95.31%           0                 0         -
templates/test.rs                   9                 0   100.00%           5                 0   100.00%          55                 0   100.00%           0                 0         -
templates/versions_yml.rs           9                 0   100.00%           3                 0   100.00%          34                 0   100.00%           0                 0         -
version/loader.rs                  58                 6    89.66%          19                 3    84.21%         140                12    91.43%           0                 0         -
version/mod.rs                     62                 1    98.39%          18                 0   100.00%         253                 0   100.00%           0                 0         -
version/resolver.rs                55                 0   100.00%          12                 0   100.00%         169                 0   100.00%           0                 0         -
version/types.rs                   19                 1    94.74%          11                 1    90.91%          60                 3    95.00%           0                 0         -
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                            1168               235    79.88%         272                40    85.29%        2974               272    90.85%           0                 0         -

Full workspace coverage details
Filename                               Regions    Missed Regions     Cover   Functions  Missed Functions  Executed       Lines      Missed Lines     Cover    Branches   Missed Branches     Cover
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
cli/src/main.rs                            823               772     6.20%          49                40    18.37%        1393              1210    13.14%           0                 0         -
core/src/config/mod.rs                      37                 1    97.30%          16                 0   100.00%         104                 0   100.00%           0                 0         -
core/src/config/recipe.rs                   60                18    70.00%          12                 2    83.33%         134                10    92.54%           0                 0         -
core/src/config/validation.rs              151                 4    97.35%          24                 0   100.00%         256                 4    98.44%           0                 0         -
core/src/error.rs                           17                 5    70.59%           8                 3    62.50%          35                 9    74.29%           0                 0         -
core/src/git/mod.rs                        165                40    75.76%          43                 9    79.07%         408                43    89.46%           0                 0         -
core/src/scaffold/bootstrap.rs             160                73    54.37%          31                11    64.52%         378                87    76.98%           0                 0         -
core/src/scaffold/mod.rs                   320                75    76.56%          55                 7    87.27%         760                68    91.05%           0                 0         -
core/src/templates/justfile.rs               8                 1    87.50%           5                 1    80.00%          26                 3    88.46%           0                 0         -
core/src/templates/mod.rs                    1                 1     0.00%           1                 1     0.00%          14                14     0.00%           0                 0         -
core/src/templates/readme.rs                16                 0   100.00%           5                 0   100.00%          84                 0   100.00%           0                 0         -
core/src/templates/recipe_yml.rs            21                 3    85.71%           4                 0   100.00%          64                 3    95.31%           0                 0         -
core/src/templates/test.rs                   9                 0   100.00%           5                 0   100.00%          55                 0   100.00%           0                 0         -
core/src/templates/versions_yml.rs           9                 0   100.00%           3                 0   100.00%          34                 0   100.00%           0                 0         -
core/src/version/loader.rs                  58                 6    89.66%          19                 3    84.21%         140                12    91.43%           0                 0         -
core/src/version/mod.rs                     62                 1    98.39%          18                 0   100.00%         253                 0   100.00%           0                 0         -
core/src/version/resolver.rs                55                 0   100.00%          12                 0   100.00%         169                 0   100.00%           0                 0         -
core/src/version/types.rs                   19                 1    94.74%          11                 1    90.91%          60                 3    95.00%           0                 0         -
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                     1991              1001    49.72%         321                78    75.70%        4367              1466    66.43%           0                 0         -

✅ Core library coverage meets the 80% threshold.

Note: Only the core library is required to meet the 80% threshold. CLI coverage is tracked but not enforced due to interactive prompts.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

🤖 Semantic Version Analysis

Result: No version bump required

Commit Analysis

Commit Type Impact Message
b10d6d5 refactor ⚪ none refactor: streamline documentation and improve CLI-first wor...

Summary

  • SDK API breaking changes (🔴 MAJOR): ✗
  • Conventional breaking changes (🔴 MAJOR): ✗
  • New features (🟡 MINOR): ✗
  • Bug fixes (🟢 PATCH): ✗

This PR contains only non-versioned changes (docs, chore, etc).


Manual override: If this is incorrect, you can manually add one of these labels:

  • semantic:major - Breaking changes
  • semantic:minor - New features
  • semantic:patch - Bug fixes
  • semantic:none - No version bump

Once a manual label is added, this workflow will respect it and not override.

@brunopgalvao brunopgalvao enabled auto-merge (squash) November 5, 2025 13:29
@brunopgalvao brunopgalvao merged commit 50bde4e into master Nov 5, 2025
12 checks passed
@brunopgalvao brunopgalvao deleted the refactor/improvements branch November 5, 2025 13:30
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