Skip to content

chore: add a make help target - #209

Merged
Glittersup merged 2 commits into
TricklePay:mainfrom
DevSolex:chore/issue-160
Aug 31, 2026
Merged

chore: add a make help target#209
Glittersup merged 2 commits into
TricklePay:mainfrom
DevSolex:chore/issue-160

Conversation

@DevSolex

Copy link
Copy Markdown
Contributor

Summary

Closes #160

Adds a help target to the Makefile that lists every available target with its one-line description. Makes help the default so running plain make with no arguments shows the usage guide instead of running the CI gate.

Changes

  • help target: parses inline ## comments on each rule line using grep + awk and prints a formatted target/description table.
  • .DEFAULT_GOAL := help: ensures make with no arguments runs help.
  • Inline ## comments: moved each target's description from a standalone # comment above the rule to an inline ## comment on the rule line, keeping descriptions co-located with the targets they describe.

Output of make help / make:

Usage: make <target>

  all             Run fmt-check, lint, and test (CI gate).
  build           Native debug build.
  wasm            Optimised WASM artifact for deployment.
  test            Run the full test suite.
  fmt             Format the workspace in place.
  fmt-check       Verify formatting without modifying files (used in CI).
  lint            Lint every target and treat warnings as errors.
  audit           Audit dependencies for known vulnerabilities.
  clean           Remove build artifacts.
  deploy          Build, install, and deploy to testnet. Pass an identity: make deploy ID=alice
  help            Show this help message.

Acceptance criteria met

  • make help lists the available targets with a one-line description each
  • help is the default target when make is run with no arguments
  • Descriptions stay in the Makefile next to the targets they describe

Verification

cargo fmt --check          ✓
cargo clippy --all-targets -- -D warnings  ✓
cargo test                 ✓  (109 tests passed)

- Add a help target that lists every available target with its one-line
  description by parsing inline ## comments from the Makefile.
- Make help the default target (.DEFAULT_GOAL := help) so running plain
  `make` with no arguments prints the usage guide instead of running
  the CI gate.
- Move each target's description from a standalone # comment to an
  inline ## comment on the rule line so descriptions stay co-located
  with the targets they describe.

Resolves TricklePay#160
@drips-wave

drips-wave Bot commented Aug 30, 2026

Copy link
Copy Markdown

@DevSolex Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Glittersup

Copy link
Copy Markdown
Contributor

Please fix conflicts @DevSolex

@Glittersup
Glittersup merged commit 3493474 into TricklePay:main Aug 31, 2026
1 check passed
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.

Add a make help target

2 participants