ryanjwessel/pear-cli

🍐 A frictionless tool for tracking pair programming activity on teams

pear-cli's Issues

Don't include "Co-authors: " tag when rebasing

If you have an active Pear session and you rebase a branch, it will append that co-author to every commit in the branch. This is not desirable, as it should maintain the existing commit messages as-is.

If anyone wants to take a stab at this one, I'd be happy to pair on it with you 🍐

Pairing frequency heatmap

Color code the pairing counts by min/max to highlight knowledge silos on the team.

Credit to @andersonvom for this great idea!

Add contributing guide

Right now, there is the .pear directory, and the src directory. The .pear directory is generated as a result of running commands from the Pear CLI, so changes should only be made in the src directory.

This is just one example of this process being unclear. Now that the CLI is ready for use on teams, this project should start to include a more streamlined contribution process.

• Lint and format changes pre-commit
• Automatically update the .pear directory based on changes from the src directory?

Generate pairing matrix with `pear matrix`

It would be great if a Markdown table could be generated from commit history that includes Co-authors: ... in the commit body.

It could support arguments for different lengths of time.

pear matrix --since "3 months ago"

And it could support the same arguments that git log accepts so there isn't too much confusion there.

Derive contributors from existing commit history

Instead of (or, in addition to) prompting the user running npx pear init to manually enter the contributor names they would like to track, we could leverage the commit history and have them select from existing contributors.

npx pear init

# Prompt them to select from contributor names from the last _n_ months of commits

# Then, continue with existing prompt that asks for manual entering

Tagged releases

I have been running yarn publish --access=public locally to publish to the npm registry. It would be great if tags could be created from the main branch, and GitHub Actions automatically published those changes.

Filter self out of `pear start` prompt

Now, it is not clear that one should not select themselves when running npx pear start. Instead of presenting all contributors for the project, we could check their current name, and filter out that option from the list.

Credit to @andersonvom for the suggestion!

Coauthors are not appended properly when using `git commit -m ""`

It seems like coauthors are prepended to the commit message when the author uses git commit -m "message", rather than using the vim editor by only entering git commit.

# with git commit -m
Co-authors: Name1, Name2
Intended commit title

# with git commit
Intended commit title

Co-authors: Name1, Name2

Rename to @pearkit/cli

SO thread for transferring packages to an organization.

If this project evolves into more functionality focused on pair programming, it will be nice to have an organization to contain any other packages.

Allow aborting a commit message without committing "Co-authors" tag

Current Behavior

Currently, we use prepare-commit-msg to include "Co-authors: {...coauthors}` in the commit body. However, if the author exits the commit editor, because there is a non-empty string included in the body, it counts as an actual commit message in your history.

Desired Behavior

If we included a commit-msg hook that checked if the body contains only empty lines and the Co-authors: tag, then we know the commit is incomplete.

Credit to @andersonvom for discovering this issue!