bdk-cli icon indicating copy to clipboard operation
bdk-cli copied to clipboard

README.md:better markdown syntax for lists

Open RandyMcMillan opened this issue 2 years ago • 8 comments

RandyMcMillan avatar Nov 22 '23 18:11 RandyMcMillan

This doesnt effect how README.md is rendered on GitHub.com. It enables correct list rendering in other markdown clients.

RandyMcMillan avatar Nov 22 '23 18:11 RandyMcMillan

Before:

pr-165-before

After:

pr-165-after

RandyMcMillan avatar Nov 22 '23 18:11 RandyMcMillan

6d84b96: update per suggestions

view rendered README.md: https://github.com/bitcoindevkit/bdk-cli/blob/6d84b9601a060e7765aaf819ad30a5201de14195/README.md

6d84b96

feel free to cherry-pick 6d84b96 and close if 854f072 isn't desirable.

RandyMcMillan avatar Nov 28 '23 23:11 RandyMcMillan

@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".

thunderbiscuit avatar Jan 12 '24 19:01 thunderbiscuit

if there is something else I need to do - please tell me.

Screen Shot 2024-01-14 at 10 34 38 AM

RandyMcMillan avatar Jan 14 '24 15:01 RandyMcMillan

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

thunderbiscuit avatar Jan 14 '24 16:01 thunderbiscuit

@notmandatory I don't have permissions to merge this because of the protections on the master branch. The PR currently fails the CI but this is a docs PR and I don't want to get into fixing all the pins on the dependencies here.

thunderbiscuit avatar Jan 14 '24 16:01 thunderbiscuit

I think we need to do a couple things before we can merge this PR:

  1. publish release bdk 0.29.1 which has MSRV fixes or just bump MSRV to 1.63 and fix CI in a 0.30.0 version
  2. update bdk-cli to use bdk 0.29.1 and fix any other msrv issues

notmandatory avatar Jan 14 '24 17:01 notmandatory