Skip to content

Conversation

MrJithil
Copy link
Contributor

@MrJithil MrJithil commented Oct 13, 2024

PR Checklist

Please check to confirm your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?
Improve the Code scaffolding section.

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Code scaffolding section is updated a while ago and new commands associated with ng generate is not included. Only a subset of available schematics is documented in this section.

Issue Number: #28059

What is the new behavior?

This PR updates the code scaffolding section to inform users about the various commands available with ng generate, such as ng generate component.

Since the list of commands may evolve in the future, it's best to guide developers to use the --help option with generate. The documentation is now rewritten to highlight the use of ng generate --help for accessing the most up-to-date list of commands.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@angular-robot angular-robot bot added area: docs Related to the documentation area: @schematics/angular labels Oct 13, 2024
@alan-agius4 alan-agius4 added the action: merge The PR is ready for merge by the caretaker label Oct 14, 2024
Copy link
Collaborator

@alan-agius4 alan-agius4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for your contribution

@alan-agius4 alan-agius4 added target: patch This PR is targeted for the next patch release target: major This PR is targeted for the next major release and removed target: patch This PR is targeted for the next patch release labels Oct 14, 2024
@alan-agius4 alan-agius4 merged commit 67d1532 into angular:main Oct 14, 2024
35 checks passed
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Nov 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker area: docs Related to the documentation area: @schematics/angular target: major This PR is targeted for the next major release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "Code scaffolding" section in README.md generated automatically

2 participants