Coder Social home page Coder Social logo

stavarengo / mob-tool Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 388 KB

Mob-Tool (mobt) is a command-line tool for remote teams to manage mob programming sessions. It simplifies Git commands, controls the timer, and switches driver roles. The tool logs all Git commands and rolls them back if errors occur.

Home Page: https://pypi.org/project/mob-tool/

License: MIT License

Python 100.00%
mob mob-programming timer cli-tool mob-programming-timer remote-mob-programming remote-mobs

mob-tool's Introduction

Mob-Tool: mobt

Mob-Tool is a command-line tool designed to facilitate mob programming sessions for remote teams. The tool provides several features to help teams manage their sessions, including controlling the timer, switching the driver role among team members, and simplifying the necessary Git commands to hand over the work to the next team member.

Mob programming is a software development approach where a team of developers works together on the same task at the same time.

What changes does the tool make to the repository?

  • No changes are made in the main branch: All changes are made in a new feature branch, and you can choose the name of the branch when you start the mob session.
  • All Git commands executed by the tool are logged in the output: This way, the team can easily see what changes are being made to their repository.
  • All commands are rolled back if any error occurs: The commands to rollback are also logged in the output.

Installation

pip install mob-tool

Important!

Please note that some operating systems might be equipped with the python3 and pip3 commands instead of python and pip (but they should be equivalent). If you don’t have pip or pip3 available in your system, please check out pip installation docs.

Usage

Starting a new session

To start a new session, use the following command:

mobt start <branch-name>

Here's an example of the output of the start command:

Example of mobt start output

Handing over to the next driver

When your time is up, pass the driver role to the next team member with the following command:

mobt next

Here's an example of the output of the next command:

Example of mobt next output

Note that you must call mob next even if you didn't make any changes in the code, so the Mob-Tool can manage whose turn is next.

The next driver (in this example, Erik) can start working by running the same mobt start <branch-name> command.

Finishing the session when the feature is done

When your feature is ready, you can end the session with the following command:

mobt done

This will squash all the commits and push all the changes to the remote. All Git hooks will be executed for this final commit. The hooks are always ignored during the start and next commands.

Here's an example of the output of the done command:

Example of mobt done output

FAQ

What happens if one of the Git commands fails?

If one of the Git commands fails, all changes made to the repository are rolled back. Here's an example of the output with a rollback in action:

Example of output with rollback

mob-tool's People

Contributors

rfst avatar stavarengo avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.