https://github.com/jul-sh/npx-co-commit

Co-author commits using GitHub usernames when pair programming
https://github.com/jul-sh/npx-co-commit

agile git nodejs pair-programming teamwork

Last synced: 1 day ago
JSON representation

Co-author commits using GitHub usernames when pair programming

• Host: GitHub
• URL: https://github.com/jul-sh/npx-co-commit
• Owner: jul-sh
• Created: 2018-10-29T15:18:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-29T18:16:29.000Z (over 1 year ago)
• Last Synced: 2024-10-16T19:17:03.325Z (24 days ago)
• Topics: agile, git, nodejs, pair-programming, teamwork
• Language: JavaScript
• Homepage:
• Size: 407 KB
• Stars: 98
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

        
# 🤝 co-commit

Run `npx co-commit` to start. - No installation needed.

![screenshot of using gif co-commit](screenshot.gif)

## 🤓 Background

GitHub allows you to [co-author commits](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) by appending `Co-authored-by: name ` to a commit message.

## 🧠 Advanced

### Make it blazing fast 🔥

Each time you run co-commit, `npx` will install the package. This will usually only takes a few seconds. To skip this you can preinstall co-commit using `npm i -g co-commit`.

### CLI arguments

You can also utilize git flags with co-commit: eg `git commit --all` becomes `npx co-commit --all`. Additionally, you can skip prompts using flags: eg: `-m "your commit message"` or `-co "mariiapunda"`.

### Multiple Co-Authors

To commit with multiple co-authors simply comma-separate their usernames.

## ⛓ Dependencies

To run co-commit you need to have [NodeJs](https://nodejs.org/en/) installed. Naturally, [git](https://git-scm.com/) is also required.

## Contributors

- [mariiapunda](https://github.com/MariiaPunda) 👩‍💻

- [juliettepretot](https://github.com/juliettepretot) 👩‍💻