Fork on GitHub: login/create an account and click the 'Fork' button at the top right corner of https://github.com/python-control/python-control/.

Clone to computer (Replace [you] with your Github username):

git clone https://github.com/[you]/python-control.git
cd python-control

Set up remote upstream:

git remote add upstream https://github.com/python-control/python-control.git

Start working on a new issue or feature by first creating a new branch with a descriptive name:

git checkout -b <my-new-branch-name>

Write great code.

• Suggestion: write the tests you would like your code to satisfy before writing the code itself. This is known as test-driven development.
• See coding conventions and testing conventions for more information

Run tests and fix as necessary until everything passes:

(for documentation, instead run touch *.rst; make html in doc directory)

Commit changes:

git add <changed files>
git commit -m "commit message that describes what changed"

Update & sync your local code to the upstream version on Github before submitting (especially if it has been a while). First go to your local branch on github.com and click sync fork at the top right of the screen. Then:

git checkout main; git fetch --all; git merge origin/main
git push

and then bring those changes into your branch:

git checkout <my-new-branch-name>; git rebase main

Push your branch to GitHub:

git push origin <my-new-branch-name>

(The first time you run this command you will need to use the following):

git push --set-upstream origin <my-new-branch-name>

Issue pull request to submit your code modifications to Github by going to your fork on Github, clicking Pull Request, and entering a description.

Other developers will provide commentary and any suggested improvements on Github. Repeat steps 5-9 until feature is complete. When the administrators are happy with your pull request, they will "merge" it into the main repository, congratulations!

To create the next pull request, move to your main branch, update it to the current upstream version:

git checkout main; git fetch --all; git merge upstream/main

and then go to step 4.