maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update OperationalNotes.md

Browse source 
Enhance Jim's "Commit dance" walk-thru. [skip ci]
This commit is contained in:
Sergei Vorobev 2016-03-11 12:14:52 -08:00
parent 85b5d6e3e0
commit e3fce651df
1 changed files with 30 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
docs/OperationalNotes.md
View file

@ -1,37 +1,50 @@
Working notes -
#Commit Dance
Most of the time, you're going to be working in a submodule (say src/monad/monad/engine).
The submodule has a relationship to the SuperProject (PowerShell), but in order to be sure that everyone is
The submodule has a relationship to the SuperProject (PowerShell), but in order to be sure that CI is
notified about changes in a submodule, you need be sure that this is reflected as a pull request in the SuperProject.
Here's the process I followed to make a change to `src/monad/monad/src/engine/DataStoreAdapter.cs`
**Scenario**: Jim fixes issue in `src/monad/monad/src/engine/DataStoreAdapter.cs`
the following takes place in the submodule:
* Make the code change
* Commit the code change
* Get the committed change into a branch
* Push the branch
* Pull request in the submodule for notification purposes
* Make the code change
* Commit the code change in a feature branch. Branch name in form `<alias>/<moniker>`, i.e `jim/colon-drive`.
* Push the branch (in the submodule project): `git push origin jim/colon-drive`
* Pull request in the submodule to notify people via email about new code review.
Then, in the SuperProject (PowerShell) (git status will show a change _in my case it was `src/monad`_)
Then, in the SuperProject (PowerShell)
* `git status` should show a change of submodule **as a whole** (not individual files). _In my case_ it is `src/monad`.
* `git diff` should show something like
* Commit that change
* Get the committed change into a branch
* Push the branch
* Pull request in the superproject for notification purposes
```diff
index 1ba8dd4..ed5d202 160000
--- a/src/monad
+++ b/src/monad
@@ -1 +1 @@
-Subproject commit 1ba8dd4f721f2cd4363f64609515ec1600378c30
+Subproject commit ed5d2022617f317a78a8a57e2c257c8e29cddbd5
```
the I used commands were:
* Commit that change into a branch with the same name, i.e. `jim/colon-drive`
* Push the branch (in the SuperProject): `git push origin jim/colon-drive`
* Pull request in the superproject to kick-in CI build and notify people. Reference submodule pull-request in the PR message to make navigation between two simpler.
### Commands log
Here is a transcript of command Jim used:
```
cd $HOME/PowerShell/src/monad/monad/src/engine
vi DataStoreAdapter.cs
git checkout -b jim/colon-drive
git commit -a
git checkout -b colon-drive
git push origin colon-drive
git push origin jim/colon-drive
```
then I went to the web interface and did the pull request *in the submodule*. After that, back to the commandline:
```
cd $HOME/PowerShell
git checkout -b colon-drive
git checkout -b jim/colon-drive
git commit -a
git push origin colon-drive
git push origin jim/colon-drive
```
and back to the web interface for the pull request *in the superproject*.