devpair 0.0.7

Pair script that manage a pair programming session using git.

Dev Pair

It's a tool to facilitate the remote pair programming session. Instead of make a lot of git add, git commit, git push, git pull, you can make it more quickly only running devpair start to start coding and devpair next to send the code to another person.

Very useful for teams that like to make pair sessions often. If you never was a driver or a navigator feel free to read here to have a context.

Install

pip install devpair

Example of use

This example only show you the commands, feel free to try with your pair :smile:

# Dev A
main $ devpair start
pair/main $ echo "hello" > welcome.txt
pair/main $ devpair next

# Dev B
main $ devpair start
pair/main $ cat welcome.txt # shows "hello"
pair/main $ echo " world" >> welcome.txt
pair/main $ devpair next

# Dev A again
pair/main $ devpair start
pair/main $ cat welcome.txt # shows "hello world"
pair/main $ echo "!" >> welcome.txt
pair/main $ devpair done

main $ git commit -m "feat: created hello world feature"
main $ git push

# Dev B again
pair/main $ devpair done # just to clear the house.

# Any Dev
pair/main $ devpair summary # print a summary

Last Dev:
     [e-mail]  | 2022-11-16 00:40:00
First Dev:
     [e-mail]  | 2022-11-15 17:55:19
Frequence:
     [e-mail]  | ▇▇ 2
     [e-mail]  | ▇ 1

How it works?

You will work inside a temporary pair branch that in the end all the commits will be squashed to be added to the feature branch.

Under the hood

Under the hood the devpair start will take your current branch and create a copy with the same name but with the prefix pair

After make your code changes the devpair next will add, commit and push your code using an internal commit message. This step will be more easier to understand checking the example step by step

In the end, we have the devpair done that will add, commit, push and delete the branch. Don't worry we will make a squash commit of everything that you did for the current branch.

if you have any doubt

devpair --help

Recommendations

• Before the pair programming
  • Define the end of the session. How many time do you want pair?
  • Define the break time.
• Use a timer like:
  • https://cuckoo.team/
  • https://double-trouble.wielo.co/
  • http://mobtimer.zoeetrope.com/
  • ANY other mobile app, web tool, smartwatch app, pomodoro timer and so on.
• The driver need to share the screen avoiding to use tools like vscode live share, even they are good it can create some hard moments that you want to show the browser or create a quickly diagram. The preference is that the driver ever need to share the screen.
• Antipatterns: https://tuple.app/pair-programming-guide/antipatterns

Contributing

Fork, create a branch from main with the pattern feat/my-feature and make a pull request with your proposal.

Local env

We are using poetry and pyenv to manage all the python versions and dependencies.

# Install the pre-commit
poetry run pre-commit install
# Install all the dependencies
poetry install
# Set the version of the `.python-version`
pyenv local
# Run all the tests
python -m pytest

Publishing

# Build the project
make build

# Publish the project
make publish