{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {},
  "_ordered_sections": [],
  "item_file": null,
  "item_line": null,
  "item_type": null,
  "aliases": [],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": null,
  "references": null,
  "qa": "dev:gitwash:development_setup",
  "arbitrary": [
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "This section and the next describe in detail how to set up git for working with the SciPy source code.  If you have git already set up, skip to "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "development-workflow",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "docs",
                "path": "dev:contributor:development_workflow"
              },
              "kind": "exists"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Getting started with Git development"
        }
      ],
      "level": 0,
      "target": "git-start"
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Developing with git can be done entirely without GitHub. Git is a distributed   version control system. In order to use git on your machine you must first   "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "install git"
                        }
                      ],
                      "url": "https://git-scm.com/downloads",
                      "title": ""
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Introduce yourself to Git        "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "git config --global user.email you@yourdomain.example.com\ngit config --global user.name \"Your Name Comes Here\"",
                  "execution_status": null
                }
              ]
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Basic Git setup"
        }
      ],
      "level": 1,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "You need to do this only once."
            }
          ]
        },
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": true,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Set up and configure a "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "github_",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " account"
                    }
                  ]
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "If you don't have a "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "github_",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " account, go to the "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "github_",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " page, and make one."
                    }
                  ]
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "You then need to configure your account to allow write access - see the    "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "Generating SSH keys"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " help on "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "github help",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Next, create your own "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "forked copy of SciPy"
                        }
                      ],
                      "url": "https://docs.github.com/get-started/quickstart/fork-a-repo",
                      "title": ""
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Making your own copy (fork) of SciPy"
        }
      ],
      "level": 1,
      "target": "forking"
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "git clone https://github.com/your-user-name/scipy.git\ncd scipy\ngit remote add upstream https://github.com/scipy/scipy.git\ngit submodule update --init",
          "execution_status": null
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Overview"
        }
      ],
      "level": 2,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "In detail"
        }
      ],
      "level": 2,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": true,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Clone your fork to the local computer with "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "git clone    https://github.com/your-user-name/scipy.git"
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Investigate.  Change directory to your new repo: "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "cd scipy"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". Then    "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "git branch -a"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " to show you all branches.  You'll get something    like        "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "* main\nremotes/origin/main",
                  "execution_status": null
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "This tells you that you are currently on the "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "main"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " branch, and    that you also have a "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "remote"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " connection to "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "origin/main"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ".    What remote repository is "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "remote/origin"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "? Try "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "git remote -v"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " to    see the URLs for the remote.  They will point to your "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "github_",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " fork."
                    }
                  ]
                },
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Now you want to connect to the upstream "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "SciPy github",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " repository, so    you can merge in changes from trunk."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Clone your fork"
        }
      ],
      "level": 3,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "cd scipy\ngit remote add upstream https://github.com/scipy/scipy.git",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "upstream"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " here is just the arbitrary name we're using to refer to the main "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "SciPy_",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " repository at "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "SciPy github",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Just for your own satisfaction, show yourself that you now have a new 'remote', with "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "git remote -v show"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", giving you something like     "
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "upstream\thttps://github.com/scipy/scipy.git (fetch)\nupstream\thttps://github.com/scipy/scipy.git (push)\norigin\thttps://github.com/your-user-name/scipy.git (fetch)\norigin\thttps://github.com/your-user-name/scipy.git (push)",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "To keep in sync with changes in SciPy, you want to set up your repository so it pulls from "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "upstream"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " by default.  This can be done with     "
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "git config branch.main.remote upstream\ngit config branch.main.merge refs/heads/main",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Your config file should now look something like (from "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "$ cat .git/config"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ")     "
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "[core]\n        repositoryformatversion = 0\n        filemode = true\n        bare = false\n        logallrefupdates = true\n        ignorecase = true\n        precomposeunicode = false\n[remote \"origin\"]\n        url = https://github.com/your-user-name/scipy.git\n        fetch = +refs/heads/*:refs/remotes/origin/*\n[remote \"upstream\"]\n        url = https://github.com/scipy/scipy.git\n        fetch = +refs/heads/*:refs/remotes/upstream/*\n[branch \"main\"]\n        remote = upstream\n        merge = refs/heads/main",
          "execution_status": null
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Linking your repository to the upstream repo"
        }
      ],
      "level": 3,
      "target": "linking-to-upstream"
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Initialize git submodules     "
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "git submodule update --init",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "This fetches and updates any submodules that SciPy needs (such as "
            },
            {
              "__type": "InlineRole",
              "__tag": 4003,
              "value": "Boost",
              "domain": null,
              "role": null,
              "inventory": null
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ")."
            }
          ]
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Update submodules"
        }
      ],
      "level": 3,
      "target": null
    },
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "You are now ready to start developing with SciPy. Check the "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "contributor-toc",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "docs",
                "path": "dev:contributor:contributor_toc"
              },
              "kind": "exists"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " for more details."
            }
          ]
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "github"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "github help"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "install it"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "subversion"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git cheat sheet"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "pro git book"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git svn crash course"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "learn.github"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "network graph visualizer"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git user manual"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git tutorial"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git community book"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git ready"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git casts"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "Fernando's git page"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git magic"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git concepts"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git clone"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git checkout"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git commit"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git push"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git pull"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git add"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git status"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git diff"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git log"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git branch"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git remote"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git config"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "why the -a flag?"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git staging area"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "tangled working copy problem"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git management"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "linux git workflow"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "ipython git workflow"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git parable"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git foundation"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "numpy/main"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git cherry-pick"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "git blame"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "this blog post"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "this article on merging conflicts"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "learn git"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "filing pull requests"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "pull request review"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "python"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "NumPy"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "NumPy github"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "NumPy mailing list"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "SciPy"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "SciPy github"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "SciPy forum"
        },
        {
          "__type": "Target",
          "__tag": 4061,
          "label": "SciPy repository"
        }
      ],
      "title": [
        {
          "__type": "Text",
          "__tag": 4046,
          "value": "Next steps"
        }
      ],
      "level": 2,
      "target": null
    }
  ],
  "local_refs": []
}