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.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review (advisory — merge authority stays with @marcelfolaron / @broskees) · first review · full diff read at head 1ac050e · open since 2025-12-21 (>14 days, flagged for age) · first-time contributor 👋

1. Intent: Updates the Test Email example in development/commandline.md — changes php ./bin/leantime email:test to php ./bin/leantime email:testemail --address="YOUREMAILADDRESS", so the documented command matches the actual CLI signature (name + required address arg).

2. Change requests (this is a factual/command-accuracy change, so verify against the real CLI before merge):

  1. ⛔ Confirm the actual command name — email:test vs email:testemail. This is the load-bearing change: docs that print a command that doesn't exist are worse than a typo. Verify against the registered console commands in leantime core (the email:* command class) that the command is genuinely email:testemail and not email:test. If core registers email:test, this change is wrong; if email:testemail, it's a real fix.
  2. Confirm the --address option name and whether it's required. The example now shows --address="YOUREMAILADDRESS". Verify (a) the option is spelled --address (not --to/--email), and (b) whether it's required or optional — if optional, a one-line note ("omit to send to the admin address") helps; if required, the example is correct as-is.
  3. (nit) YOUREMAILADDRESS placeholder reads fine; consider you@example.com to match the convention used elsewhere in the docs, but not blocking.

3. Acceptance checklist (must pass before merge):

  1. Command name + option verified against core's registered email:* console command (CR new documentation draft ready for review #1Update quick-installation.md #2) — this is the gate for a command-reference doc.
  2. The documented invocation actually sends a test email when run against a configured instance (a 30-second manual check settles CR new documentation draft ready for review #1+Update quick-installation.md #2 at once).
  3. Page renders cleanly (single code-block edit — safe).

4. CI status: No code/test surface — docs-only. The one real risk is documenting a non-existent command/flag; the manual verification in checklist #2 is the gate. Open since Dec 2025 — resolve this cycle.

Advisory review only — not an approval, and I am not marking this ready or merging. Merge authority stays with @marcelfolaron / @broskees.

@marcelfolaron

Copy link
Copy Markdown
Contributor

Maintainer review (advisory — merge authority stays with @marcelfolaron / @broskees) · flagged in today's sweep as a long-open, never-reviewed PR (opened 2025-12-21, >14 days) from a first-time contributor · reviewed at head 1ac050e

1. Intent: Updates commandline.md to document the --address parameter on the email test command: php ./bin/leantime email:testemail --address="YOUREMAILADDRESS". Not a typo fix — a real documentation-accuracy improvement.

2. Change requests:

  1. Verify the flag against the current command signature (this is the one substantive check for a docs-accuracy PR). Confirm the email:testemail console command actually accepts --address on the version the docs target, and that the example invocation path is correct — the PR shows php ./bin/leantime while some docs use php bin/leantime / ./bin/leantime. Match whatever the rest of commandline.md uses so a copy-paste works.
  2. Confirm whether --address is required or optional (and what the behavior is without it) — a one-line note on that would make the doc more useful than the bare example.

3. Acceptance checklist (must pass before merge):

  1. --address confirmed as a real, current parameter of email:testemail; invocation prefix matches the rest of the doc.
  2. Docs site builds.
  3. N/A — docs-only, no code/schema/API change.

4. CI status: No readable CI gate. Because this documents a command contract (not just prose), CR #1 — verifying the flag exists — is the gate before merge, unlike the pure typo PRs. Thanks, @danp-dev.

Advisory 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