Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coauthors/coauthors
Easier to share ideas
https://github.com/coauthors/coauthors
cli coauthor coauthors commit git github husky prepare-commit-msg vscode-extension
Last synced: about 1 hour ago
JSON representation
Easier to share ideas
- Host: GitHub
- URL: https://github.com/coauthors/coauthors
- Owner: coauthors
- License: mit
- Created: 2024-04-11T06:34:00.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-18T16:14:01.000Z (6 months ago)
- Last Synced: 2025-02-08T11:04:20.384Z (12 days ago)
- Topics: cli, coauthor, coauthors, commit, git, github, husky, prepare-commit-msg, vscode-extension
- Language: TypeScript
- Homepage: https://coauthors.me
- Size: 5.08 MB
- Stars: 52
- Watchers: 0
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/coauthors/coauthors/blob/main/LICENSE) [](https://www.npmjs.com/package/@coauthors/core) [](https://www.npmjs.com/package/@coauthors/core)
[](http://coauthors.me) [](https://codecov.io/gh/coauthors/coauthors)  
## GitHub App
[Intall Coauthors GitHub App](https://github.com/apps/coauthors)

## Git Hook with Husky
1. Setup with husky
```shell
# .husky/prepare-commit-msg
npx coauthors
```2. Commit with coauthors simply
```shell
git commit -m "chore: updatecoauthors: manudeli, 2-NOW(Whale)"
```3. Commit message with coauthors prepare-commit-msg
```text
chore: updateCo-authored-by: Jonghyeon Ko <[email protected]>
Co-authored-by: Whale <[email protected]>
```### `coauthors -m`: CLI to get commit message with coauthors
1. With coauthors
```shell
npx coauthors -m "chore: updatecoauthors: manudeli, 2-NOW(Whale)"
``````text
chore: updateCo-authored-by: Jonghyeon Ko <[email protected]>
Co-authored-by: Whale <[email protected]>
```2. Without coauthors
```shell
npx coauthors -m "chore: update"
``````text
chore: update
```## Coauthors Generator
[Enter coauthors.me/generator](https://coauthors.me/generator)
[](https://coauthors.me/generator)
## VSCode Extension
1. Icon on source control to add coauthor string easily
[](https://coauthors.me)
2. Status bar item to use Coauthors generator easily
[](https://coauthors.me)
## Contributing
Read our [Contributing Guide](./CONTRIBUTING.md) to familiarize yourself with Coauthors's development process, how to suggest bug fixes and improvements, and the steps for building and testing your changes.
### Contributors
[](https://github.com/coauthors/coauthors/graphs/contributors)
## License
MIT © Coauthors. See [LICENSE](./LICENSE) for details.