commithub
v0.0.13
Published
<p align="center"> <a href="https://www.commithub.app/" target="_blank" rel="noopener noreferrer"> <img width="800" src="./src/assets/show-case-v2.png" alt="commithub-showcase logo"> </a> </p>
Downloads
11
Maintainers
Readme
commithub
The CLI tool to track your company's commits on your GitHub profile.
Merge all development activity in one place! Track your company's commits to getting motivated from GitHub!
Commithub is a cli tool that helps you to track your company's commits on your GitHub profile. It collects all commits from your company's repositories and merges them into one repository. Then it pushes the as a dummy(empty) commits to your GitHub profile. Witout any security issues!
Why commithub?
- Becouse your github profile is your resume.
- While you are working on your company's repositories, you can't see your commits on your GitHub profile if you are not working with your personal account.
- You can't show your company's commits to your future employer.
- You can't show your company's commits to your friends.
- You can track your company's commits on your GitHub profile.
- You can get motivated from your company's commits.
How does it work?
Commithub collects all commits from your company's repositories and merges them into one repository. Then it pushes the commits to your GitHub profile.
How to use?
Prerequisites
- You need to have a GitHub account.
1. Install
$ npm install -g commithub
2. Initialize
$ commithub init
Commithub will ask you some questions to initialize your commithub. You can answer the questions with the following options:
Company Name
: Your GitHub username.A new repository for collect your company commits
: Store your company's commits.Personal GitHub email
: Your GitHub email.Company Email
: Your GitHub password.
These informations stored in your local machine. Commithub doesn't store any information about you!
3. Collect commits
$ commithub collect-commits
Commithub will collect all commits from your company's repositories and merge them into one repository. Then it will push the commits to your GitHub profile.
3. See your company's commits on your GitHub profile
You can see your company's commits on your GitHub profile.
How to contribute?
You can contribute to this project by:
- Reporting bugs
- Feature advice
- Improve experience
You can create an issue for any of these. And please feel free to reach out to me on @hasantezcann if you have any questions.
License
MIT
Author
Hasan Tezcan
Installation
$ npm install -g commithub
After installation, you can run the command commithub
from anywhere.
Now you can initialize
your commithub anywhere on your computer.
$ commithub init
After initialization, you can start to collect your company commits
with commithub.
$ commithub collect-commits
That's it! Now you can see your company's commits on your github profile.
Contributing
Please feel free to contribute to this project. You can contribute by:
- Reporting bugs
- Feature advice
- Improve experience
You can create an issue for any of these. And please feel free to reach out to me on @hasantezcann if you have any questions.