You Do Not Need to Tell Me I Have A Typo in My Documentation | /en/2013/06/fix-typo-in-documentation/

yihui 2022-12-16 23:07:05

You Do Not Need to Tell Me I Have A Typo in My Documentation

https://yihui.org/en/2013/06/fix-typo-in-documentation/

8 Comments

giscus-bot 2022-12-16 23:07:06

Guest *swalberg* @ 2013-06-11 12:54:52 originally posted:

You shouldn't even need to go that far, it can all be done on the GitHub site. I submitted a pull request (yihui/knitr#554) to add the procedure to the FAQ without leaving my web browser.

giscus-bot 2022-12-16 23:07:07

Guest *Hadley Wickham* @ 2013-06-11 13:00:50 originally posted:

Or just edit directly on github with their in-page editor...

giscus-bot 2022-12-16 23:07:13

Guest *Barry Rowlingson* @ 2013-06-11 13:12:45 originally posted:

Can you edit someone else's repo and magically generate a pull request without any additional forking? That would be nice. You have to keep your fork synced with the original by adding an upstream remote, don't you?

giscus-bot 2022-12-16 23:07:14

Guest *swalberg* @ 2013-06-11 13:15:40 originally posted:

If you edit a repo you don't have access to, it forks the repo and creates a feature branch behind the scenes. After you submit the changes (which is a commit) it puts you right into the pull request form.

yihui 2022-12-16 23:07:18

That is nice. I did not realize this would trigger an automatic fork. Just tried it and it looks good. Thanks for the tip!

Originally posted on 2013-06-12 00:55:24

giscus-bot 2022-12-16 23:07:07

Guest *mrdwab* @ 2013-06-11 14:02:02 originally posted:

You have a typo in your flowchart. Shouldn't it be "I have a typo in my documentation"? :p

yihui 2022-12-16 23:07:15

That is indeed funny. I shot my own feet. I just realized that I was imagining a conversation between A (user/reader) and B (author):

A: You have a typo in your documentation.
B: Can you fix it?
A: Yes/No.
B: Learn GIT/Send me a pull request.

Originally posted on 2013-06-12 00:50:23

giscus-bot 2022-12-16 23:07:20

Guest *mrdwab* @ 2013-06-12 12:19:41 originally posted:

I understood your intent, but couldn't resist the comment :)

giscus-bot 2022-12-16 23:07:22

Guest *Ian Gow* @ 2015-01-30 21:10:28 originally posted:

I laughed when I read this (I think we see the same humor here). Meta-Git humor is pretty nerdy for sure. Nice, informative post.

giscus-bot 2022-12-16 23:07:08

Guest *Yingjie* @ 2013-06-11 17:06:47 originally posted:

Today I learned how github works. I don't know why I don't like the style of github website and make me not be willing to learn. After reading your post, I learned what is fork and pull. These two words are not obvious in their literal meaning especially when they are translated into Chinese.

yihui 2022-12-16 23:07:16

Honestly, I still do not know how to translate these two verbs into Chinese. It is really difficult find proper words in Chinese.

Originally posted on 2013-06-12 00:51:38

giscus-bot 2022-12-16 23:07:19

Guest *Glen* @ 2013-06-12 01:39:52 originally posted:

The intended English sense of 'fork' here is the sense in which a road or river splits from one into two, which may then diverge and have different destinations (called a fork presumably because of the visual similarity to a two-tine fork, like an old agricultural fork (see http://www.equiport.co.uk/catalogue/images/large01176.jpg)). That sense of a dividing road or river might help.

yihui 2022-12-16 23:07:21

Thank you! That helped a lot!

Originally posted on 2013-06-12 20:03:07

giscus-bot 2022-12-16 23:07:09

Guest *Dave X* @ 2013-06-11 18:05:55 originally posted:

What's the etiquette on deleting forks after the pull? I don't want to serve an out-of-date fork or have to maintain a trivial fork.

yihui 2022-12-16 23:07:17

If you delete the fork after sending me a pull request that has been accepted, the history of your commits will be preserved in my repository, so you are free to delete such trivial forks.

Originally posted on 2013-06-12 00:54:19

giscus-bot 2022-12-16 23:07:10

Guest *RobinLovelace* @ 2013-08-12 02:33:39 originally posted:

I just made my first pull request to an external repo thanks to this post. yihui/knitr-examples#14 Thanks!

yihui 2022-12-16 23:07:21

Thanks a lot!

Originally posted on 2013-08-18 07:41:19

giscus-bot 2022-12-16 23:07:11

Guest *Zafar Hussain* @ 2018-10-02 11:50:04 originally posted:

I did a pull request today to your repo, thanks to your article, cheers

yihui 2022-12-16 23:07:23

Good job!

Originally posted on 2018-10-02 13:29:06

giscus-bot 2022-12-16 23:07:12

Guest *whenov* @ 2021-09-29 06:48:38 originally posted:

Sadly this is not accepted by everyone. Discussion (in Chinese)

yihui 2022-12-16 23:07:24

I think there is a consensus that fixing a typo with a PR is great (I love it, too, and have merged many PRs like this), but bragging it as "Oh I've become a contributor to the most popular Github repo and the most famous programmer just merged my PR" is not that great, because he was playing on the word "contributor", as if his contribution were as substantial as other contributors and the most famous programmer "endorsed" his programming skills.

Bragging is okay, as long as it matches your effort.

Originally posted on 2021-09-29 14:41:51