Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TypeScript - Angular] Add syntax highlighting to code blocks and correct heading levels in README.mustache #19837

Merged

Conversation

bameyrick
Copy link
Contributor

General improvements to the typescript-angular/README.mustache file.

  • Add syntax highlighting to code blocks
  • Correct heading levels

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha

- Add syntax highlighting to code blocks
- Correct heading levels
@macjohnny
Copy link
Member

thanks for your contribution

can you please regenerate the samples?

@bameyrick
Copy link
Contributor Author

Hi @macjohnny, thanks for the approval. I've now updated the samples.

@macjohnny macjohnny merged commit 368b9b7 into OpenAPITools:master Oct 10, 2024
15 checks passed
@bameyrick bameyrick deleted the angular-readme-mustach-improvements branch October 10, 2024 16:17
@wing328 wing328 added this to the 7.10.0 milestone Nov 18, 2024
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.

4 participants