doc: Fix grammar and punctuation in developer notes #16530

Tech1k commented at 2:49 AM on August 2, 2019: contributor

This pull request is regarding minor grammar and punctuation errors in the developer notes. There were no modifications to the existing code, only alterations to fix the grammar and punctuation in the text to make the developer notes more understandable and easier to read.

fanquake added the label Docs on Aug 2, 2019

Tech1k marked this as ready for review on Aug 2, 2019

in doc/developer-notes.md:429 in fd7e5cb6b9 outdated

 425 | @@ -424,7 +426,7 @@ to do this is thus to create your local gitignore. Add this to `~/.gitconfig`:
 426 |  (alternatively, type the command `git config --global core.excludesfile ~/.gitignore_global`
 427 |  on a terminal)
 428 |  
 429 | -Then put your favourite tool's temporary filenames in that file, e.g.
 430 | +Then put your favorite tool's temporary filenames in that file, e.g.

fanquake commented at 6:21 AM on August 2, 2019:

This can be spelt either way, so you can leave it as is.

in doc/developer-notes.md:652 in fd7e5cb6b9 outdated

 652 | -  with braces
 653 | +  with braces.
 654 |  
 655 |    OK:
 656 | -
 657 | +

fanquake commented at 6:22 AM on August 2, 2019:

You've introduced white space here and below.

fanquake commented at 6:23 AM on August 2, 2019: member

These changes look ok, however you'll need to fix up the trailing white space to appease the linter.

fanquake commented at 8:10 AM on August 2, 2019: member

Please squash your changes into a single commit. You commit message and description in the first commit is fine.

Tech1k commented at 3:28 PM on August 2, 2019: contributor

Please squash your changes into a single commit. You commit message and description in the first commit is fine. @fanquake Could I please have some assistance with squashing these commits before I mess everything up. I already have the pull request open for edits from maintainers. Thank you in advance.

practicalswift commented at 5:02 PM on August 2, 2019: contributor

@Tech1k git rebase -i HEAD~4 then change from pick to fixup on L2-4. Exit editor and git push -f. Done! :-)

Welcome as a contributor!

Tech1k commented at 8:55 PM on August 2, 2019: contributor

@practicalswift Did I get it just right or did I wreak more havoc to the pull request?

practicalswift commented at 6:47 AM on August 3, 2019: contributor

@Tech1k The commits tab shows six commits -- it should be one when you've successfully squashed. Please see if https://github.com/wprig/wprig/wiki/How-to-squash-commits can help you out :-)

Tech1k commented at 2:26 PM on August 3, 2019: contributor

@practicalswift Thank you for pointing me in the right direction. I'm only 14 years old and I need to 'git' my act together. Especially as I begin to write some unit tests for Bitcoin in the dialect of Python.

doc: Fix grammar and punctuation in developer notes

This pull request is regarding minor grammar and punctuation errors in the developer notes. There were no modifications to the existing code, only alterations to fix the grammar and punctuation in the text.

Update developer-notes.md

Update developer-notes.md

Revert "Update developer-notes.md"

This reverts commit dfeb0bacb054ed24766f8af7bae0c0166b0cb4cb.

b2ea20d330

fanquake approved

fanquake commented at 1:49 AM on August 6, 2019: member

ACK b2ea20d3302275a62bbdfdb96169c6788fe7b9c1

If you're looking for more ways to contribute, check out the good first issue tag.

In future, when squashing commits, make sure you prune all of the intermediate commit messages from your commit body. i.e there are still multiple "Update developer-notes.md" lines left here.

fanquake merged this on Aug 6, 2019

fanquake closed this on Aug 6, 2019

fanquake referenced this in commit fbe4b7665b on Aug 6, 2019

Munkybooty referenced this in commit 4e1fcd06d3 on Nov 25, 2021

Munkybooty referenced this in commit f1e3f4302d on Nov 25, 2021

Munkybooty referenced this in commit a4e2c74b50 on Nov 30, 2021

DrahtBot locked this on Dec 16, 2021