Skip to content

Make the content of generated md files to be markdown compatible - #43925

Closed
thil4n wants to merge 0 commit into
ballerina-platform:masterfrom
thil4n:master
Closed

thil4n wants to merge 0 commit into
ballerina-platform:masterfrom
thil4n:master

Conversation

@thil4n

@thil4n thil4n commented Mar 17, 2025

Copy link
Copy Markdown
Contributor

Purpose

This PR fixes the Markdown compatibility issue in the generated readme.md file for bal new -t lib command.

Fixes #42907

Approach

Edit the static file cli/ballerina-cli/src/main/resources/new_cmd_defaults/README.md.

Check List

  • Read the Contributing Guide
  • Updated Change Log
  • Checked Tooling Support (#)
  • Added necessary tests
    • Unit Tests
    • Spec Conformance Tests
    • Integration Tests
    • Ballerina By Example Tests
  • Increased Test Coverage
  • Added necessary documentation
    • API documentation
    • Module documentation in Module.md files
    • Ballerina By Examples

Comment thread cli/ballerina-cli/src/main/resources/new_cmd_defaults/README.md Outdated
Comment thread cli/ballerina-cli/src/main/resources/new_cmd_defaults/README.md Outdated
@azinneera

Copy link
Copy Markdown
Contributor

The first 2 commit messages can be squashed into one since the messages seem to be the same. The commit message should start with Uppercase and in the imperative mood.

@thil4n

thil4n commented Mar 19, 2025

Copy link
Copy Markdown
Contributor Author

The first 2 commit messages can be squashed into one since the messages seem to be the same. The commit message should start with Uppercase and in the imperative mood.

Ack, Will use proper commit messages.

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.

[Improvement]: Make the content of generated md files to be markdown compatible

2 participants