lfit / github2gerrit

Github PR to Gerrit Change request
Other
2 stars 3 forks source link

Invalid markdown syntax in README.md #10

Closed ModeSevenIndustrialSolutions closed 1 month ago

ModeSevenIndustrialSolutions commented 1 month ago

The markdownlint tool flags the following:

README.md:23:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/2/3]
README.md:24:1 MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 4; Style: 1/2/3]
README.md:25:1 MD029/ol-prefix Ordered list item prefix [Expected: 3; Actual: 5; Style: 1/2/3]
README.md:26:1 MD029/ol-prefix Ordered list item prefix [Expected: 4; Actual: 6; Style: 1/2/3]
README.md:27:1 MD029/ol-prefix Ordered list item prefix [Expected: 5; Actual: 7; Style: 1/2/3]
README.md:36:90 MD033/no-inline-html Inline HTML [Element: sha]

(this is with long-line checks disabled, those are flagged in multiple places by the default tool configuration)

ModeSevenIndustrialSolutions commented 1 month ago

Note: this kind of mixed bullet point types is discouraged:


2. One of the below options can be used depending on the workflow followed by the community.

- Squash all the commits in the pull request into a single commit and use consolidate the commit titles and body into a single commit (Default).
- Squash all the commits in the pull request into a single commit and using the pull request title and body as the commit title and body (USE_PR_AS_COMMIT).
- Submit each commit as a separate single commit preserving the git history (SUBMIT_SINGLE_COMMITS).

3. Check for a Change-Id line in the pull request commit message. If it is not present, add the Change-Id to the commit. If the Change-Id is found in any of the commits, it will be reused along with the patch.```
ModeSevenIndustrialSolutions commented 1 month ago

README.md markdown syntax issues addressed in: https://github.com/lfit/github2gerrit/pull/11 Also note, have embedded hidden SPDX licensing hints into this file too.

ModeSevenIndustrialSolutions commented 1 month ago

Change merged.