microsoft / microsoft/AzureTRE-Deployment

make help should list AzureTRE commands as well

Open
#132 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
18
Forks
32
Avg merge
8d 18h
Merged PRs (30d)
1

Description

Description

Currently the only commands returned by make help are repository specific commands. It would be good to have a custom help command that merges help messages from both the repository-specific Makefile and the AzureTRE Makefile. This allow developers to quickly identify and understand the available make commands and their descriptions.

Acceptance Criteria

  • The Makefile should include a help command that outputs help messages from both the current Makefile and the AzureTRE Makefile.
  • The help command should format the output for readability.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository Makefile and inspect how its current help command gathers and formats repository-specific targets. Then locate the AzureTRE Makefile and determine how both help sources can be combined; run make help to verify that commands from both Makefiles are present and readable.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
build-system
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.