GEODE-9619: [documentation] Align contents section in README#6888
GEODE-9619: [documentation] Align contents section in README#6888davebarnes97 merged 2 commits intoapache:developfrom
Conversation
nikochiko
requested review from
kirklund,
pivotal-amurmann and
upthewaterspout
as code owners
|
@nikochiko Thank you for your contribution! |
There was a problem hiding this comment.
+1
I reviewed the change using macdown, and verified that this PR fixes the list format issue.
Note: in macdown, the frontmatter (Geode logo, etc) does not render correctly, but it looks fine when you view the rendering on the Github repo page.
Also note: A code owner review is still required before merging will be allowed.
|
Hey @davebarnes97 Thank you for reviewing the pull request. |
nikochiko
changed the title
Looks like an extra character was accidentally introduced.
* Align contents in README * Fixed typo in "How to Contribute" Co-authored-by: Dan Smith <dasmith@vmware.com>
3 participants
Jira ticket: https://issues.apache.org/jira/projects/GEODE/issues/GEODE-9619
Came here from ApacheCon, saw this and thought I'll start my contributions here 😄
This PR adds changes to format the contents section of the README in a way that the 9th and 10th list element are not rendered on to the same line. I've also changed the numbering from 1,2,3,4 to 1,1,1,1 so that Markdown can figure out the numbering (lesser chance of missing a number in the list)
Before:
After:
For all changes:
Is there a JIRA ticket associated with this PR? Is it referenced in the commit message?
Has your PR been rebased against the latest commit within the target branch (typically
develop)?Is your initial contribution a single, squashed commit?
Does
gradlew buildrun cleanly?Have you written or updated unit tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?