-
Notifications
You must be signed in to change notification settings - Fork 65
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
README.md:better markdown syntax for lists #165
base: master
Are you sure you want to change the base?
README.md:better markdown syntax for lists #165
Conversation
This doesnt effect how README.md is rendered on GitHub.com. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. When looking at it though I see a few more things that could be improved. Do you mind fixing these as well?
- The first 3 bullets under "This crate can be used for the..." can all be at the same level (the last 2 are not subpoints of the first one).
- The other list (Database Options, Blockchain Options, etc.) do not need indentation at the first level, and the second level can get 4 spaces of indentation.
Roughly I'd like us to try to adhere to the Google Markdown Styleguide, so that markdown is rendered the same everywhere. Thanks for catching this!
d425df2
to
6d84b96
Compare
6d84b96: update per suggestions view rendered README.md: https://github.com/bitcoindevkit/bdk-cli/blob/6d84b9601a060e7765aaf819ad30a5201de14195/README.md feel free to cherry-pick 6d84b96 and close if 854f072 isn't desirable. |
@RandyMcMillan if you can give me commit access to your PR I'll be able to push some small fixes and get this merged. I'm trying to clean up some of the PRs and move stuff along, sorry it's slow going. It's apparently a small checkbox that says "Allow edits by maintainers". |
Actually this will (I think) work, but in general you don't need to grant complete access to your repo for maintainers to be able to push commits on a PR. I think this is the article to take a look at: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork |
ec720c9
to
7c2dc52
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 7c2dc52. Thanks for the contribution!
@notmandatory I don't have permissions to merge this because of the protections on the |
I think we need to do a couple things before we can merge this PR:
|
No description provided.