Skip to content

Update docs commandline.md file#47

Open
danp-dev wants to merge 2 commits into
Leantime:masterfrom
danp-dev:master
Open

Update docs commandline.md file#47
danp-dev wants to merge 2 commits into
Leantime:masterfrom
danp-dev:master

Conversation

@danp-dev

@danp-dev danp-dev commented Dec 21, 2025

Copy link
Copy Markdown

Update the Email test to include the --address parameter for testing.

php .bin/leantime email:testemail --address="YOUREMAILADDRESS"

update the test Email section to include the address parameter
@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review (advisory — merge authority stays with @marcelfolaron / @broskees)

Intent: Updates the "Test Email" example in development/commandline.md from the outdated email:test to the current email:testemail --address="YOUREMAILADDRESS".

Change requests:

  1. Verify the canonical command name before merge. The new form matches how the command is actually invoked in the wild (e.g. email:testemail --address=... used in support threads on docker-leantime), so this looks correct. Please confirm against the current email:testemail command signature in the core repo that --address is the exact option name.
    • development/commandline.md:47php ./bin/leantime email:testemail --address="YOUREMAILADDRESS" ✔ (pending the confirmation above)
  2. Minor consistency: surrounding examples in this file use the php ./bin/leantime ... prefix, which this diff preserves — good, no change needed.

Acceptance checklist (must pass before merge):

  1. Confirm email:testemail + --address is the current, correct command/flag in the shipping CLI (this is a behavior/usage doc, so accuracy is the gate).
  2. CLA signed / green (first-time contributor).
  3. Rendered code block displays the quoted --address="..." correctly.

CI status: No automated test covers doc command accuracy — treat "does the documented command actually run" as the manual test gate. Not mergeable until item 1 is confirmed, since a wrong command name would ship a regression in the docs.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review — status: needs-info (advisory) · priority: P3 · next action: verify command name against source · owner: @danp-dev

1. Intent: Updates the "Test Email" example in development/commandline.md to use the correct command and the required --address parameter.

2. Change requests:

  • Verify before merge (correctness): the change at development/commandline.md:47 renames the command from email:test to email:testemail:
    -php ./bin/leantime email:test
    +php ./bin/leantime email:testemail --address="YOUREMAILADDRESS"
    This is a documented command name, so it must match the actual registered console command in leantime. Please confirm the command is email:testemail (not email:test) in the current release — if the real signature differs, the docs would send users to a command that doesn't exist. A quick php ./bin/leantime list | grep email on a current install settles it.
  • Nit (consistency): other examples in this file use php ./bin/leantime — this line matches, good. Consider showing --address as an angle-bracket placeholder (--address=<your-email>) for consistency with the repo's placeholder style, optional.

3. Acceptance checklist (must pass before merge):

  • Command name email:testemail verified against the current console command registry
  • Docs build/link-check CI green
  • No behavior change in code — docs-only, no test required

4. CI status: Not readable through my current tooling — confirm green in the UI. The only real gate here is verifying the command name matches source; no unit test applies to a docs change.

Advisory review only — not an approval. Merge authority stays with @marcelfolaron / @broskees.

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