Mainly used branches

• main

• devops

  All commits/changes will be merged on devops branches from contributors forked branch.

• release

  After the release of new version, it will be pushed to release branch

Workflow details

1. Fork visualpython repository as your remote repository

   On Github, you can just fork it clicking 'Fork' button on the upper-right side of the page.

   

2. Clone your forked repository on local environment

   $ git clone [your-repository-link]
   

   • Where to get repository link?

     Copy link on github clone part, or copy your url from brower link box.

     

   • Where to clone?

     We recommend to make a symbolic link(soft-link) under jupyter nbextensions' directory and make seperated developing environment.

     • How to find jupyter nbextensions' directory?

       • for anaconda

         1. search list of conda environments

            $ conda-env list
            
            # output
            # conda environments:
            #
            base                     C:\\Users\\UserName\\anaconda3
            env2                  *  C:\\Users\\UserName\\anaconda3\\envs\\env2
            

         2. get path of asterisked one (*)

            C:\Users\UserName\anaconda3\envs\env2

         3. add this given path after that

            • given path : \share\jupyter\nbextensions

            ⇒ FULL PATH : C:\Users\UserName\anaconda3\envs\env2\share\jupyter\nbextensions

     • How to make a symbolic link on Windows?

       > mklink /d "link_path/link_name" "original_path"
       

     • How to make a symbolic link on Linux?

       $ ln -s original_path link_path/link_name
       

3. Work on 'devops' branch

   $ git checkout devops
   

4. Add original repository as upstream

   ## check remote repository list
   $ git remote -v
   ## add upstream
   $ git remote add upstream <https://github.com/visualpython/visualpython.git>
   

5. Stage your changes and Commit it

   # check status
   $ git status
   
   # stage all changes (or specific files' path)
   $ git add .
   
   # commit all changes
   $ git commit -m "#issue_number - commit comments..."
   # example
   $ git commit -m "#54 - Frame fixed"
   

6. keep in touch with upstream(original repository) by fetching it

   ## fetch upstream
   $ git fetch upstream
   ## rebase before push (after commit all changes you made)
   $ git rebase upstream/devops
   

• 6-2. If something's wrong with rebase operation?

1. Push codes and Request merge

   $ git push origin devops
   

   Request merge on GitHub page with detailed description of commits.

Git Cheatsheet

Git Cheat sheet

Error and Solution

1. remote: Support for password authentication was removed on August 13, 2021.

• How to solve