search

Breakthrough-Energy / docs

Documentation
https://breakthrough-energy.github.io/docs/
Creative Commons Attribution 4.0 International
13 stars 14 forks source link

doc: add section discouraging git pull #75

Closed danielolsen closed 2 years ago

danielolsen commented 2 years ago

Purpose

Add a section discouraging git pull with no additional arguments, plus some other small tweaks.

What the code is doing

No code.

Testing

Built the docs manually, they look alright.

Time estimate

15 minutes.

merrielle commented 2 years ago

git config --global pull.rebase true makes git pull default to rebase. I recommend adding a note about that in the docs.

At first I was confused about why git pull was bad and then I remembered that config option isn't the default. 😅

danielolsen commented 2 years ago

git config --global pull.rebase true makes git pull default to rebase. I recommend adding a note about that in the docs.

At first I was confused about why git pull was bad and then I remembered that config option isn't the default. 😅

I added a bit about git config, let me know what you think.