{"id":15605727,"url":"https://github.com/ajitsing/pairing_matrix","last_synced_at":"2025-04-28T17:05:47.461Z","repository":{"id":56887324,"uuid":"85616281","full_name":"ajitsing/pairing_matrix","owner":"ajitsing","description":"Pairing Matrix For Agile Teams","archived":false,"fork":false,"pushed_at":"2021-01-05T13:00:54.000Z","size":94,"stargazers_count":29,"open_issues_count":1,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-15T18:49:51.161Z","etag":null,"topics":["agile","extreme-programming","matrix-visualizer","pair-programming","pairing","pairing-matrix","ruby-gem","sinatra-applications","tool"],"latest_commit_sha":null,"homepage":"http://www.singhajit.com/pairing-matrix-for-agile-teams/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajitsing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-20T19:13:40.000Z","updated_at":"2024-12-17T21:59:34.000Z","dependencies_parsed_at":"2022-08-21T00:50:46.444Z","dependency_job_id":null,"html_url":"https://github.com/ajitsing/pairing_matrix","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2Fpairing_matrix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2Fpairing_matrix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2Fpairing_matrix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2Fpairing_matrix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajitsing","download_url":"https://codeload.github.com/ajitsing/pairing_matrix/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251352585,"owners_count":21575861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agile","extreme-programming","matrix-visualizer","pair-programming","pairing","pairing-matrix","ruby-gem","sinatra-applications","tool"],"created_at":"2024-10-03T04:13:55.761Z","updated_at":"2025-04-28T17:05:47.444Z","avatar_url":"https://github.com/ajitsing.png","language":"Ruby","readme":"# PairingMatrix\n\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/ajitsing/pairing_matrix/graphs/commit-activity)\n[![Gem Version](https://badge.fury.io/rb/pairing_matrix.svg)](https://badge.fury.io/rb/pairing_matrix)\n[![HitCount](http://hits.dwyl.io/ajitsing/pairing_matrix.svg)](http://hits.dwyl.io/ajitsing/pairing_matrix)\n![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/pairing_matrix?type=total)\n[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/MIT)\n[![Twitter Follow](https://img.shields.io/twitter/follow/Ajit5ingh.svg?style=social)](https://twitter.com/Ajit5ingh)\n\n\u003cimg src=\"https://github.com/ajitsing/ScreenShots/blob/master/pairing_matrix/pairing_mat.png\" width=\"900\" height=\"550\" /\u003e\n\n## How to read this matrix?\n    1. This matrix is purely based on commits.\n    2. Darker the line more the pair has worked together.\n    3. If you see a dark red circle around a name that means the person has worked alone\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'pairing_matrix'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install pairing_matrix\n\n## Usage\n\nFirst of all you need to decide a format for your commit messages e.g.\n#Feature [Dev1/Dev2] Your commit message\n\nYou can choose any format as long as you are able to extract dev names from the message using a regex.\nOnce you have decided on the commit message format, create a ```pairing_matrix.yml``` file.\n\n```yml\nauthors_regex: ^.*\\[([\\w]*)(?:\\/)?([\\w]*)\\].*$\n\ngithub:\n  url: https://api.github.com/\n  access_token: 000324cgf89weq56132f32c345hn679c0knh501c\n  repositories:\n    - org1/repo1\n    - org1/repo2\n    - github_username/my_private_repo\n```\n\n#### authors_regex:\nThis regex is used to extract dev names from the commit message. You can verify your regex in irb console using the below command. If your regex is correct it will return an array of dev names.\n\ne.g\n```ruby\n\"#4324 [Ajit/Abhishek] My commit message\".scan(/^.*\\[([\\w]*)(?:\\/)?([\\w]*)\\].*$/).flatten\n=\u003e [\"Ajit\", \"Abhishek\"]\n```\n\n#### access_token:\nIf you want to use private repos for matrix, then create a access token and give it the repo read permission. Here is how you can create the token: \n\n**Github:** https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/\n\n**Gitlab:** https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html\n\n#### repositories:\nList your repos which you want to use for matrix. If you have your repos inside organization then follow the ```org/repo``` format else just mention ```username/repo```.\n\n\nNow after installing the pairing matrix gem, simply run the ```pairing_matrix``` command in the repo where you have ```pairing_matrix.yml``` file. This command will start a web server.\nThen hit the url [localhost:4567/matrix](http://localhost:4567/matrix) or [localhost:4567](http://localhost:4567) in the browser. In case you want to use the json data, hit [http://localhost:4567/data/:days](http://localhost:4567/data/30)\n\n# Supported code hosting platforms\n\nPairing matrix gem supports below platforms:\n* Github\n* Gitlab\n* Local\n\nSupport for bitbucket is coming soon!\n\n### Github sample configuration\n\n```yaml\nauthors_regex: ^.*\\[([\\w]*)(?:\\/)?([\\w]*)\\].*$\n\ngithub:\n  url: https://api.github.com/\n  access_token: 000324cff69wes5613f732c345hn679c0knt509c\n  repositories:\n    - org1/repo1\n    - org1/repo2\n    - github_username/my_private_repo\n```\n\n**Note: Access token is optional if you are using public repositories.**\n\n### Gitlab sample configuration\n\n```yaml\nauthors_regex: ^.*\\[([\\w]*)(?:\\/)?([\\w]*)\\].*$\n\ngitlab:\n  url: https://gitlab.com/api/v4\n  access_token: G7EmKQs4swhadZn2sd0T\n  repositories:\n    - username/repo1\n    - username/repo2\n```\n\n**Note: Add your custom urls if you are using enterprise version of Github or Gitlab.**\n\n### For local repositories\n\n```yaml\nauthors_regex: ^.*\\[([\\w]*)(?:\\/)?([\\w]*)\\].*$\nlocal:\n  repositories:\n    - /Users/Ajit/projects/project1\n    - /Users/Ajit/projects/project2\n    - /Users/Ajit/projects/project3\n```\n\n## Contributing\n\n1. Fork it ( https://github.com/ajitsing/pairing_matrix/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n\n## License\n```LICENSE\nCopyright (c) 2021 Ajit Singh\n\nMIT License\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajitsing%2Fpairing_matrix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajitsing%2Fpairing_matrix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajitsing%2Fpairing_matrix/lists"}