Collect: Add instructions about squashing commits in CONTRIBUTING.md
Software and hardware versions
Collect v1.11.1, All
Problem description
Add instructions about squashing the commits in pull requests.
Steps to reproduce the problem
NA
Expected behavior
There should be instructions about squashing the commits into one with meaningful commit message in the CONTRIBUTING.md file.
Other information
I do understand this means rewriting the history and not all pull requests need to be squashed into one but the contributor should squash all the WIP and minor changes into one.
@lognaturel Views ?
dr0pdb
All 5 comments
I agree it would be useful to have clearer guidelines around commit messages. The ideal would be small, meaningful commits that make the evolution of the code easy to trace. You can see some examples at https://github.com/opendatakit/collect/commits?author=batkinson
Some resources I like on the topic are https://dev.bleacherreport.com/small-commits-for-fun-and-profit-part-1-git-add-patch-c0966a562b10 and https://www.bignerdranch.com/blog/small-distinct-commits-say-you-care/. Ideally only the smallest features would involve a single commit.
Right now most contributors' commits don't tend to be very meaningful. In that case, maintainers can squash upon merge but I think we should start to move more aggressively to requiring commits that tell a meaningful story, make review faster and more meaningful and help track down future problems.
lognaturel
on 14 Dec 2017
@opendatakit-bot claim
dr0pdb
on 14 Dec 2017
I wonder how to ensure that each of multiple commits for a single file results in something that compiles and runs right. A file is atomic as far as the compiler is concerned.
dcbriccetti
on 15 Dec 2017
Hello @srv-twry, you have been unassigned from this issue because you have not updated this issue or any referenced pull requests for over 10 days.
You can reclaim this issue or claim any other issue by commenting @opendatakit-bot claim on that issue.
Thanks for your contributions, and hope to see you again soon!
getodk-bot
on 29 Dec 2017
This will require deeper policy discussion across the ODK project before it can be an issue to close.
lognaturel
on 12 Feb 2018
Related issues
lognaturel
路
3Comments
rcovane
路
3Comments
seadowg
路
4Comments
mmarciniak90
路
5Comments
mateusmedeiros
路
4Comments
Most helpful comment
I agree it would be useful to have clearer guidelines around commit messages. The ideal would be small, meaningful commits that make the evolution of the code easy to trace. You can see some examples at https://github.com/opendatakit/collect/commits?author=batkinson
Some resources I like on the topic are https://dev.bleacherreport.com/small-commits-for-fun-and-profit-part-1-git-add-patch-c0966a562b10 and https://www.bignerdranch.com/blog/small-distinct-commits-say-you-care/. Ideally only the smallest features would involve a single commit.
Right now most contributors' commits don't tend to be very meaningful. In that case, maintainers can squash upon merge but I think we should start to move more aggressively to requiring commits that tell a meaningful story, make review faster and more meaningful and help track down future problems.