search

FlowModelingControl / flowtorch

flowTorch - a Python library for analysis and reduced-order modeling of fluid flows
GNU General Public License v3.0
131 stars 45 forks source link

First modification and commit #6

Closed AndreWeiner closed 3 years ago

AndreWeiner commented 4 years ago

Hi @MehdiMak96 , let's make the first change on the linear_algebra_basics.ipynb notebook.

  1. make sure that you are working on the correct branch (not master): git status; you can change branches using git checkout branch_name (always use the tab-key for autocompletion)
  2. open the linear algebra notebook and make a modification 
    cd notebooks
jupyter lab
# now you are working in the browser
# open linear_algebra_basics.ipynb ( left side menu; double click)
# add some markdown or code to one of the cells
# close the notebook: File -> Shut Down
  3. go back to the top-level of the repository and run git status again; there should be exactly one modified file, namely linear_algebra_basics.ipynb
  4. stage the modification using 
    git add  notebooks/linear_algebra_basics.ipynb
  5. check again that the modification is staged git status (the color should have changed from red to orange)
  6. commit the change; mention this issue in the commit message using the syntax #issue_number; the number of this issue should be 6 
    git commit -m"Make first modification according to issue #6."
  7. push the changes on your branch to the central repository 
    git push origin name_of_your_branch

    Best, Andre

MehdiMak96 commented 3 years ago

done!! i hope everything is correct.

AndreWeiner commented 3 years ago

Hi Mahdi, I guess something went wrong since you haven't pushed anything to the repository. You can try to repeat the steps. Carefully read the Git output to find potential issues. Otherwise, we go through the process together on Monday. Best, Andre

MehdiMak96 commented 3 years ago

can you please check it out.... I tried it again :)

AndreWeiner commented 3 years ago

The commit and the new branch have been correctly pushed to the repository, nice! The commit message could have been better, though. Next time, don't forget to mention the issue you are referring to. A potential commit message could have been: Add small change to linear algebra notebook to test git/github workflow; related to issue #6.