doc: Improve contibutor doc formatting and readability #17964

pull kirankashyap wants to merge 1 commits into bitcoin:master from kirankashyap:patch-1 changing 1 files +9 −5

kirankashyap commented at 7:30 AM on January 19, 2020: none
1. Converted types of refactoring into a numbered list
2. Removed readability
fanquake added the label Docs on Jan 19, 2020
kirankashyap requested review from fanquake on Jan 19, 2020

in CONTRIBUTING.md:184 in e9ec9a9907 outdated

 184 | +3. Code refactoring
 185 | +
 186 | +In general, refactoring pull requests should not mix these
 187 | +three kinds of activity. Following this guideline will make refactoring pull requests easy to
 188 | +review and uncontroversial. In all cases, refactoring pull requests must not change the
 189 | +behaviour of code. _Even bugs must be preserved as is._

emilengler commented at 6:44 PM on January 19, 2020:

A sentence starting with Even looks a bit weird to me (I could be wrong, English isn't my mother tongue). Maybe move it back into brackets like it was before?

kirankashyap commented at 1:57 AM on January 20, 2020:

updated the changes as suggested. thanks for the suggestions.

emilengler commented at 6:50 PM on January 19, 2020: contributor

Hello kirankashyap, welcome to Bitcoin Core :)

First please be sure to include a prefix to your pull request. Please change it to "doc: Improve contributor doc formatting and readability"

Also because of your requested review from fanquake. Please use the request review function only if you really know that THIS SPECIFIC person should review your PR but your PR could be reviewed by probably anyone as it is only some formatting and language improvements.
kirankashyap renamed this:
~~Improve contibutor doc formatting and readability~~
doc: Improve contibutor doc formatting and readability
on Jan 20, 2020
kirankashyap commented at 1:58 AM on January 20, 2020: none

Thanks for the comments. I have updated the title.

I will make sure not to add reviewers hereafter.
emilengler commented at 11:06 AM on January 20, 2020: contributor

Also be sure to squash your commits. There is a guide for it in the CONTRIBUTING.md file
kirankashyap force-pushed on Jan 20, 2020
kirankashyap commented at 1:13 PM on January 20, 2020: none

Also be sure to squash your commits. There is a guide for it in the CONTRIBUTING.md file @emilengler I just resubmitted a single commit instead of two. Thanks for the guidance.
emilengler commented at 1:20 PM on January 20, 2020: contributor
No problem. But keep in mind that the doc: prefix also needs to be in the commit text. To edit your commit message do:
```
git rebase -i HEAD~1
```
then edit the pick to reword After this adjust the commit message and save it. Finally:
```
git push origin patch-1 -f
```
Contact me on IRC if you need some sort of live chat support :D
doc: Improve contibutor doc formatting and readability ea56571dff
kirankashyap force-pushed on Jan 20, 2020
kirankashyap commented at 2:32 PM on January 20, 2020: none

@emilengler I just pushed the commit with revised commit text as suggested. Thanks for the suggestion
fanquake commented at 2:52 AM on January 23, 2020: member

I don't think the changes here are necessarily an improvement. The final sentence still needs fixing, of code(Even bugs must be preserved as is)., and the lines now break the 80 character word wrapping for no reason.

If you're interested in getting started contributing to the project I'd suggest looking at the good first issue list.
fanquake closed this on Jan 23, 2020
DrahtBot locked this on Feb 15, 2022

Contributors

Labels