{ "__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:contributor:development_workflow", "arbitrary": [ { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note: consider watching" } ] }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "SciPy Development Workflow" } ], "url": "https://youtu.be/HgU01gJbzMY", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "before or after\nreading to see an example of fixing a bug and submitting a pull request." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This guide assumes that you have created your own fork (copy) of the SciPy repository, cloned the repository on your own machine, and built SciPy from this source code. If you haven't, check the " }, { "__type": "CrossRef", "__tag": 4002, "value": "building-from-source", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "building:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " pages appropriate to your system. Before getting started here, there are two other things you need to do just once before you start modifying SciPy." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In a terminal, introduce yourself to Git " } ] }, { "__type": "Code", "__tag": 4050, "value": "git config --global user.email you@yourdomain.com\ngit config --global user.name \"Your Name\"", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This information credits you for your work, but note that it will become publicly available if you \"push\" your work to GitHub. See " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "Setting your commit email address in Git" } ], "url": "https://help.github.com/en/articles/setting-your-commit-email-address-in-git", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Navigate to the root directory of your local SciPy repository and enter " } ] }, { "__type": "Code", "__tag": 4050, "value": "git remote add upstream https://github.com/scipy/scipy.git", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This associates the name " }, { "__type": "InlineCode", "__tag": 4051, "value": "upstream" }, { "__type": "Text", "__tag": 4046, "value": " with the official SciPy repository located at " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "https://github.com/scipy/scipy.git" } ], "url": "https://github.com/scipy/scipy.git", "title": "" }, { "__type": "Text", "__tag": 4046, "value": ". Note that when you cloned your fork of the SciPy repository, Git already associated the name " }, { "__type": "InlineCode", "__tag": 4051, "value": "origin" }, { "__type": "Text", "__tag": 4046, "value": " with your fork. The reason you need both of these " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "\"remotes\"" } ], "url": "https://help.github.com/en/categories/managing-remotes", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " is that you will typically start with the latest version of SciPy from the official repository " }, { "__type": "InlineCode", "__tag": 4051, "value": "upstream" }, { "__type": "Text", "__tag": 4046, "value": ", make changes, \"push\" your changes to your fork of the repository " }, { "__type": "InlineCode", "__tag": 4051, "value": "origin" }, { "__type": "Text", "__tag": 4046, "value": ", and then submit a \"pull request\" asking SciPy to \"pull\" your changes from your fork into the official repository." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "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": "Development workflow" } ], "level": 0, "target": "development-workflow" }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In short:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Start a new " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "feature branch" } ] }, { "__type": "Text", "__tag": 4046, "value": " for each set of edits that you do. See " }, { "__type": "CrossRef", "__tag": 4002, "value": "below", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:development_workflow" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Hack away! See " }, { "__type": "CrossRef", "__tag": 4002, "value": "below", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:development_workflow" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When finished:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "Contributors" } ] }, { "__type": "Text", "__tag": 4046, "value": ": push your feature branch to your own Github repo, and " }, { "__type": "CrossRef", "__tag": 4002, "value": "create a pull request", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:development_workflow" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "Core developers" } ] }, { "__type": "Text", "__tag": 4046, "value": " If you want to push changes without further review, see the notes " }, { "__type": "CrossRef", "__tag": 4002, "value": "below", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:gitwash:useful_git" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This way of working helps to keep work well organized and the history as clear as possible." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "seealso", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "seealso " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "There are many online tutorials to help you " }, { "__type": "InlineRole", "__tag": 4003, "value": "learn git", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". For discussions of specific git workflows, see these discussions on " }, { "__type": "InlineRole", "__tag": 4003, "value": "linux git workflow", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineRole", "__tag": 4003, "value": "ipython git workflow", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Basic workflow" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "First, navigate to the SciPy root directory in your terminal and fetch new commits from the " }, { "__type": "InlineCode", "__tag": 4051, "value": "upstream" }, { "__type": "Text", "__tag": 4046, "value": " repository " } ] }, { "__type": "Code", "__tag": 4050, "value": "git fetch upstream", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Then, create a new branch based on the main branch of the upstream repository " } ] }, { "__type": "Code", "__tag": 4050, "value": "git checkout -b my-new-feature upstream/main", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Equivalently, you might want to keep the main branch of your own repository up to date and create a new branch based on that " } ] }, { "__type": "Code", "__tag": 4050, "value": "git checkout main\ngit rebase upstream/main\ngit checkout -b my-new-feature", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In order, these commands" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "ensure that the " }, { "__type": "InlineCode", "__tag": 4051, "value": "main" }, { "__type": "Text", "__tag": 4046, "value": " branch of your local repository is checked out," } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "apply all the latest changes from the " }, { "__type": "InlineCode", "__tag": 4051, "value": "upstream/main" }, { "__type": "Text", "__tag": 4046, "value": " (main SciPy repository main branch) to your local " }, { "__type": "InlineCode", "__tag": 4051, "value": "main" }, { "__type": "Text", "__tag": 4046, "value": " branch, and" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "create and check out a new branch (" }, { "__type": "InlineCode", "__tag": 4051, "value": "-b" }, { "__type": "Text", "__tag": 4046, "value": ") based on your local " }, { "__type": "InlineCode", "__tag": 4051, "value": "main" }, { "__type": "Text", "__tag": 4046, "value": " branch." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In any case, it's important that your feature branch include the latest changes from the upstream main to help avoid " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "merge conflicts" } ], "url": "https://help.github.com/en/articles/resolving-a-merge-conflict-using-the-command-line", "title": "" }, { "__type": "Text", "__tag": 4046, "value": " when it's time to submit a pull request." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It's also a good idea to build this branch and run tests before continuing. Assuming you've followed one of the " }, { "__type": "CrossRef", "__tag": 4002, "value": "building-from-source", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "building:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " pages to set up your development environment, you'll need to activate your development environment and then run tests (note that the " }, { "__type": "InlineCode", "__tag": 4051, "value": "spin test" }, { "__type": "Text", "__tag": 4046, "value": " command will perform a build automatically if needed) " } ] }, { "__type": "Code", "__tag": 4050, "value": "conda activate scipy-dev\nspin test -v", "execution_status": null } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Making a new feature branch" } ], "level": 2, "target": "making-a-new-feature-branch" }, { "__type": "Section", "__tag": 4015, "children": [], "title": [ { "__type": "Text", "__tag": 4046, "value": "The editing workflow" } ], "level": 2, "target": "editing-workflow" }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "# hack hack\ngit status # Optional\ngit diff # Optional\ngit add modified_file\ngit commit\n# push the branch to your own Github repo\ngit push origin my-new-feature", "execution_status": null } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Overview" } ], "level": 3, "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": "Make some changes. When you feel that you've made a complete, working set of related changes, move on to the next steps." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional: Check which files have changed with " }, { "__type": "InlineCode", "__tag": 4051, "value": "git status" }, { "__type": "Text", "__tag": 4046, "value": " (see " }, { "__type": "InlineRole", "__tag": 4003, "value": "git status", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "). You'll see a listing like this one " } ] }, { "__type": "Code", "__tag": 4050, "value": "# On branch my-new-feature\n# Changed but not updated:\n# (use \"git add ...\" to update what will be committed)\n# (use \"git checkout -- ...\" to discard changes in working directory)\n#\n#\tmodified: README\n#\n# Untracked files:\n# (use \"git add ...\" to include in what will be committed)\n#\n#\tINSTALL\nno changes added to commit (use \"git add\" and/or \"git commit -a\")", "execution_status": null } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional: Compare the changes with the previous version using with " }, { "__type": "InlineCode", "__tag": 4051, "value": "git diff" }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineRole", "__tag": 4003, "value": "git diff", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "). This brings up a simple text browser interface that highlights the difference between your files and the previous version." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Add any relevant modified or new files using " }, { "__type": "InlineCode", "__tag": 4051, "value": "git add modified_file" }, { "__type": "Text", "__tag": 4046, "value": " (see " }, { "__type": "InlineRole", "__tag": 4003, "value": "git add", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "). This puts the files into a staging area, which is a queue of files that will be added to your next commit. Only add files that have related, complete changes. Leave files with unfinished changes for later commits." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "To commit the staged files into the local copy of your repo, do " }, { "__type": "InlineCode", "__tag": 4051, "value": "git commit" }, { "__type": "Text", "__tag": 4046, "value": ". At this point, a text editor will open up to allow you to write a commit message. Read the " }, { "__type": "InlineRole", "__tag": 4003, "value": "commit message section", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " to be sure that you are writing a properly formatted and sufficiently detailed commit message. After saving your message and closing the editor, your commit will be saved. For trivial commits, a short commit message can be passed in through the command line using the " }, { "__type": "InlineCode", "__tag": 4051, "value": "-m" }, { "__type": "Text", "__tag": 4046, "value": " flag. For example, " }, { "__type": "InlineCode", "__tag": 4051, "value": "git commit -am \"ENH: Some message\"" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In some cases, you will see this form of the commit command: " }, { "__type": "InlineCode", "__tag": 4051, "value": "git commit -a" }, { "__type": "Text", "__tag": 4046, "value": ". The extra " }, { "__type": "InlineCode", "__tag": 4051, "value": "-a" }, { "__type": "Text", "__tag": 4046, "value": " flag automatically commits all modified files and removes all deleted files. This can save you some typing of numerous " }, { "__type": "InlineCode", "__tag": 4051, "value": "git add" }, { "__type": "Text", "__tag": 4046, "value": " commands; however, it can add unwanted changes to a commit if you're not careful. For more information, see " }, { "__type": "InlineRole", "__tag": 4003, "value": "why the -a flag?", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " - and the helpful use-case description in the " }, { "__type": "InlineRole", "__tag": 4003, "value": "tangled working copy problem", "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": "Push the changes to your forked repo on " }, { "__type": "InlineRole", "__tag": 4003, "value": "github_", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ": " } ] }, { "__type": "Code", "__tag": 4050, "value": "git push origin my-new-feature", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For more information, see " }, { "__type": "InlineRole", "__tag": 4003, "value": "git push", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Assuming you have followed the instructions in these pages, git will create a default link to your " }, { "__type": "InlineRole", "__tag": 4003, "value": "github_", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " repo called " }, { "__type": "InlineCode", "__tag": 4051, "value": "origin" }, { "__type": "Text", "__tag": 4046, "value": ". In git >= 1.7, you can ensure that the link to origin is permanently set by using the " }, { "__type": "InlineCode", "__tag": 4051, "value": "--set-upstream" }, { "__type": "Text", "__tag": 4046, "value": " option " } ] }, { "__type": "Code", "__tag": 4050, "value": "git push --set-upstream origin my-new-feature", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "From now on, " }, { "__type": "InlineRole", "__tag": 4003, "value": "git_", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " will know that " }, { "__type": "InlineCode", "__tag": 4051, "value": "my-new-feature" }, { "__type": "Text", "__tag": 4046, "value": " is related to the " }, { "__type": "InlineCode", "__tag": 4051, "value": "my-new-feature" }, { "__type": "Text", "__tag": 4046, "value": " branch in your own " }, { "__type": "InlineRole", "__tag": 4003, "value": "github_", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " repo. Subsequent push calls are then simplified to the following " } ] }, { "__type": "Code", "__tag": 4050, "value": "git push", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "You have to use " }, { "__type": "InlineCode", "__tag": 4051, "value": "--set-upstream" }, { "__type": "Text", "__tag": 4046, "value": " for each new branch that you create." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It may be the case that while you were working on your edits, new commits have been added to " }, { "__type": "InlineCode", "__tag": 4051, "value": "upstream" }, { "__type": "Text", "__tag": 4046, "value": " that affect your work. In this case, follow the " }, { "__type": "CrossRef", "__tag": 4002, "value": "rebasing-on-main", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:gitwash:useful_git" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " instructions to apply those changes to your branch." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "In more detail" } ], "level": 3, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Commit messages should be clear and follow a few basic rules." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Example " } ] }, { "__type": "Code", "__tag": 4050, "value": "MAINT/TST: fft: remove xp backend skips, test `fftfreq` `device`\n\nThe first line of the commit message starts with a capitalized acronym\n(or multiple, options listed below) indicating what type of commit this is.\nThen a blank line, then more text if needed.\nReferences to code names should be enclosed in backticks.\nIf changes are limited to certain submodules or functions, they should be\nincluded after the acronym(s) - backticks are not needed here.", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Example " } ] }, { "__type": "Code", "__tag": 4050, "value": "BUG:sparse.linalg.gmres: add early exit when `x0` already solves problem\n\nLines shouldn't be longer than 72 characters. If the commit is related to an issue,\nindicate that with \"See gh-3456\", \"Closes gh-3456\", or similar,\nin the extended description.\nHowever, if you are pushing many commits to a PR, you should avoid including\nthis in every commit message as it will clutter the linked issue.", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Describing the motivation for a change, the nature of a bug for bug fixes or some details on what an enhancement does are also good to include in a commit message. Messages should be understandable without looking at the code changes. A commit message like " }, { "__type": "InlineCode", "__tag": 4051, "value": "MAINT: fixed another one" }, { "__type": "Text", "__tag": 4046, "value": " is an example of what not to do; the reader has to go look for context elsewhere." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Standard acronyms to start the commit message with are " } ] }, { "__type": "Code", "__tag": 4050, "value": "API: an (incompatible) API change\nBENCH: changes to the benchmark suite\nBLD: change related to building SciPy\nBUG: bug fix\nDEP: deprecate something, or remove a deprecated object\nDEV: development tool or utility\nDOC: documentation\nENH: enhancement\nMAINT: maintenance commit (refactoring, typos, etc.)\nREV: revert an earlier commit\nSTY: style fix (whitespace, PEP8)\nTST: addition or modification of tests\nREL: related to releasing SciPy", "execution_status": null }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note You can add some markers to skip part of the continuous integration." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "CrossRef", "__tag": 4002, "value": "continuous-integration", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:continuous_integration" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Writing the commit message" } ], "level": 3, "target": "writing-the-commit-message" }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When you feel your work is finished, you can create a pull request (PR). Github has a nice help page that outlines the process for " }, { "__type": "InlineRole", "__tag": 4003, "value": "filing pull requests", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If your changes involve modifications to the API or addition/modification of a function, you should initiate a code review. This involves sending an email to the " }, { "__type": "InlineRole", "__tag": 4003, "value": "SciPy forum", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " with a link to your PR along with a description of and a motivation for your changes." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Asking for your changes to be merged with the main repo" } ], "level": 3, "target": "asking-for-merging" }, { "__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": "Did you check that the code can be distributed under a BSD license? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "license-considerations", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:hacking" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Are there unit tests with good code coverage? See " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "NumPy/SciPy Testing Guidelines" } ], "url": "https://docs.scipy.org/doc/numpy/reference/testing.html", "title": "" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Do all unit tests pass locally? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "the-spin-interface", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "building:index" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Do all public function have docstrings including examples? See the " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "numpydoc docstring guide" } ], "url": "https://numpydoc.readthedocs.io/en/latest/format.html", "title": "" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Does the documentation render correctly? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "rendering-documentation", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:rendering_documentation" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Is the code style correct? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "pep8-scipy", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:pep8" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Are there benchmarks? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "benchmarking-with-asv", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:benchmarking" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Is the commit message formatted correctly? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "writing-the-commit-message", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:development_workflow" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Is the docstring of the new functionality tagged with " }, { "__type": "InlineCode", "__tag": 4051, "value": ".. versionadded:: X.Y.Z" }, { "__type": "Text", "__tag": 4046, "value": " (where " }, { "__type": "InlineCode", "__tag": 4051, "value": "X.Y.Z" }, { "__type": "Text", "__tag": 4046, "value": " is the version number of the next release? See the " }, { "__type": "InlineCode", "__tag": 4051, "value": "updating" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "workers" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineCode", "__tag": 4051, "value": "constraints" }, { "__type": "Text", "__tag": 4046, "value": " documentation of " }, { "__type": "Text", "__tag": 4046, "value": "|differential_evolution|_" }, { "__type": "Text", "__tag": 4046, "value": ", for example." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In case of larger additions, is there a tutorial or more extensive module-level description? Tutorial files are in " }, { "__type": "InlineCode", "__tag": 4051, "value": "doc/source/tutorial" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If new files are added, are they integrated correctly via " }, { "__type": "InlineCode", "__tag": 4051, "value": "meson.build" }, { "__type": "Text", "__tag": 4046, "value": "? See " }, { "__type": "CrossRef", "__tag": 4002, "value": "compiled-code", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "docs", "path": "dev:contributor:contributor_toc" }, "kind": "exists" }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ] }, { "__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" }, { "__type": "Target", "__tag": 4061, "label": "Scipy Development Workflow" }, { "__type": "Target", "__tag": 4061, "label": "Setting your commit email address in Git" }, { "__type": "Target", "__tag": 4061, "label": "\"remotes\"" }, { "__type": "Target", "__tag": 4061, "label": "NumPy/SciPy Testing Guidelines" }, { "__type": "Target", "__tag": 4061, "label": "numpydoc docstring guide" }, { "__type": "Target", "__tag": 4061, "label": "the wiki" }, { "__type": "Target", "__tag": 4061, "label": "differential_evolution" } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Checklist before submitting a PR" } ], "level": 3, "target": "pr-checklist" } ], "local_refs": [] }