I work in an agile team which follows extreme programming practices like pairing programming. But with pair programming comes the problem of switching pairs. Sometimes in big teams we do see that the individuals are not able to make the decision of with whom they should pair next. To overcome this problem we generally create pairing matrix which helps us figure out who is pairing with whom and wether team is switching pairs frequently or not.
Managing the hand made pairing matrix is a pain. Also maintaining the matrix of more than a month is difficult and space consuming on the white boards. I wanted a matrix that can allow me to see the pairing data based on the time span without much effort. To solve this problem I created a rubygem which automates the generation of pairing matrix based on the git commits.
How to read this matrix?
- This matrix is purely based on git commits.
- Darker the line more the pair has worked together.
- If you see a darker red circle around a name that means the person has worked alone.
How pairing matrix gem works?
The matrix is generated using the git commits presents in your git repositories. I would suggest to point the pairing matrix to your code hosting platform like github or gitlab so that everyone sees the same copy of the matrix.
Installation of gem
Run the below command in your terminal:
1 gem install pairing_matrix
To automate pairing matrix you need to provide following detail:
- Regex to extract pair name from the commit message
- Access token
- Url of the code hosting platform APIs
You need to add all this information in the
pairing_martix.yml file. Please refer to the below github sample configuration.
1 2 3 4 5 6 7 8 9 authors_regex: ^.*\[([\w]*)(?:\/)?([\w]*)\].*$ github: url: https://api.github.com/ access_token: 000324cgf89weq56132f32c345hn679c0knh501c repositories: - org1/repo1 - org1/repo2 - github_username/my_private_repo
How to test the author regex?
First of all you need to follow a particular pattern in your git commit messages. Then you can write a regex to extract the dev names from the commit message. Also make sure that all the devs in the team follows the same commit message pattern for all the commits. For example:
4324 [Ajit/Abhishek] My commit message StoryNumber [Dev1/Dev2] message
You can choose any format as long as you are able to extract dev names from the message using a regex. To figure out if your regex is correct, you can try the regex on the commit message in irb.
1 2 "4324 [Ajit/Abhishek] My commit message".scan(/^.*\[([\w]*)(?:\/)?([\w]*)\].*$/).flatten => ["Ajit", "Abhishek"]
Once you are ready with your regex, put it in the pairing_matrix.yml and run the below command from the same directory.
This command starts the sinatra server on the machine on port 4567. Now go to web browser and type localhost:4567/matrix. You should start seeing the pairing matrix based on the data you have provided in the pairing_matrix.yml file.
Supported code hosting platforms
Pairing matrix gem supports below platforms:
Support for bitbucket is coming soon!
Github sample configuration
1 2 3 4 5 6 7 8 9 authors_regex: ^.*\[([\w]*)(?:\/)?([\w]*)\].*$ github: url: https://api.github.com/ access_token: 000324cff69wes5613f732c345hn679c0knt509c repositories: - org1/repo1 - org1/repo2 - github_username/my_private_repo
Note: Access token is optional if you are using public repositories.
Gitlab sample configuration
1 2 3 4 5 6 7 8 authors_regex: ^.*\[([\w]*)(?:\/)?([\w]*)\].*$ gitlab: url: https://gitlab.com/api/v4 access_token: G7EmKQs4swhadZn2sd0T repositories: - username/repo1 - username/repo2
Note: Add your custom urls if you are using enterprise version of Github or Gitlab.
For local repositories
1 2 3 4 5 6 authors_regex: ^.*\[([\w]*)(?:\/)?([\w]*)\].*$ local: repositories: - /Users/Ajit/projects/project1 - /Users/Ajit/projects/project2 - /Users/Ajit/projects/project3
You can also use all these configurations together if you have repositories on multiple platforms.
I hope you will now be able to automate your pairing matrix using this tool. If you have any questions or feedback, please write it in the comment below. For any feature request or reporting bug create an issue on Github. Thanks!