Missing documentation on pull-request command

[blakeembrey]

Not sure where the best place to get started is here, but the documentation (both man pages and from Commands.md) is missing. I'd like to work on this and maybe add some tests for any others that are missing, if you could point me in the right direction 😄

[nicolaiskogheim]

Good to hear!

We create our man pages and html versions from markdown. Create a file called git-pull-request.md in the man directory, and when you want to se how it looks:

make docs
man ./man/git-pull-request

And then you should see your man-page. You will need the ruby-gem ronn to generate the man-pages.

I suggest you look at some of the other man pages to get ideas. You can copy the contents of one of the markdown files and go from there. We try to mimick the git man pages in wording and style. There are, though, some styling limitations because of ronn, as you will see (I'm thinking about the very padded examples, among other things).

When you have a good man page, you will also have examples and a description which you can reuse in Commands.md.

Feel free to open a PR early, and we can discuss things as you go. :)

[al-the-x]

@blakeembrey Do you have a PR for this yet? Happy to assist...

[blakeembrey]

I don't, sorry! Caught up with lots of things, I'd appreciate if someone else wanted to pick this up 😄

[al-the-x]

Happy to give it a go, then.

[tfendin]

This issue seems to be fixed now, could be closed.