search

online-bridge-hackathon / DDS

An api that returns DDS results for a given deal or partial deal
https://bit.ly/bridge-hackathon
Apache License 2.0
4 stars 6 forks source link

Cloudshell build and deploy procedure #54

Closed tameware closed 4 years ago

tameware commented 4 years ago

I addressed comments and rebased. Please have another look and let me know if the rebase was useful!

tameware commented 4 years ago

Updated and (re)rebased…

suokko commented 4 years ago

I addressed comments and rebased. Please have another look and let me know if the rebase was useful!

For this pull request I would think one commit is enough. You are writing a single documentation. To do that you would need git rebase -i origin/master followed by editing file look something like following (commit hashes in second column have potential to be different for you):

pick 4ffccc6 Create README.gcp.md
fixup 8a2d933 Update README.gcp.md
fixup 26c2a10 Update README.gcp.md
fixup ee93355 Added a pointer to our discord channel
fixup ce109a9 Linked to README.md
fixup 75140c6 Updated first line
fixup a3634ae Update pip3 install to use requirements.txt
fixup 69bd0bb Use cmake to install the library
fixup de19165 Build with debugging symbols

# Rebase 5fb6df6..de19165 onto 69bd0bb (9 commands)
# <Help comments continue here>

Thinking here is that all commits are aiming to write a documentation unit which should real fore be single commit only. Then when looking history you can one commit with header like "Document google cloud deployment" it is easy to know what changed there compared to seeing 9 individual commits.

This would have a bigger impact when modifying code instead of documentation. Then you might want to find a broken commit with git bisect to look for first bad commit. Then split commits can lead much easier to commits which don't work requiring skipping which slows down bisect.

tameware commented 4 years ago

I tried git rebase -i origin/master followed by a force push. Please let me know if the pull looks better now.

I agree that using many small commits is better for code than for docs. By now it's a habit! But it does show where I've taken comments into account.

suokko commented 4 years ago

Looks good to me, too. We can clean requirements.txt in a later commit. There seems to be indirect requirements which should be installed by pip based on package dependencies.