Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albertolinde/git-contribution-extractor
Ever looked at your GitHub contributions graph and wished it was greener and fuller? 🌳 Introducing `git-contribution`! 🎉 This CLI tool helps you make your contributions map lush by extracting commit data from any repo and recreating it in a new one. Keep contributing with passion! ❤️👨💻👩💻
https://github.com/albertolinde/git-contribution-extractor
Last synced: about 2 months ago
JSON representation
Ever looked at your GitHub contributions graph and wished it was greener and fuller? 🌳 Introducing `git-contribution`! 🎉 This CLI tool helps you make your contributions map lush by extracting commit data from any repo and recreating it in a new one. Keep contributing with passion! ❤️👨💻👩💻
- Host: GitHub
- URL: https://github.com/albertolinde/git-contribution-extractor
- Owner: AlbertoLinde
- License: mit
- Created: 2024-08-13T20:06:08.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-15T18:24:22.000Z (5 months ago)
- Last Synced: 2024-11-09T19:19:07.183Z (2 months ago)
- Language: JavaScript
- Size: 73.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git Contribution Extractor
## Description
Ever looked at your GitHub contributions graph and wished it was greener, fuller, and just more impressive? 🌳 Maybe you want to show off a year's worth of solid work or perhaps visualize it in 3D like this [awesome example](https://github.com/yoshi389111/github-profile-3d-contrib). But, oh no! Most of your contributions are tied up in private company projects you can't share. What to do?
Introducing `git-contribution`! 🎉 This CLI tool is your new best friend for making your GitHub contributions map as green as a lush forest. Select the author you want to extract logs from, and we'll handle the rest. **No real information from your original projects is exposed**; we only take the author's name and the commit dates to recreate these in a new repository. This means you can push these to your personal GitHub and watch your contribution graph turn green! 🌟
**Important Reminder**: Your GitHub name and email must match the ones used in these new commits for them to show up on your contribution map! Otherwise, no green squares for you. 🟥
**Remember**: More green squares don't make you a better programmer. This is just for fun and to showcase your hard work. Keep contributing and coding with passion! ❤️👨💻👩💻
## Installation
To install the `git-contribution` tool globally, use the following command:
```bash
npm install -g git-contribution
```
## Usage
To run the tool, simply use the command:
```bash
git-contribution
```
This will start an interactive session where you can select the author, specify the Git repository path, and choose the output details.
## Requirements
- Node.js version 12.0.0 or higher
- Git
- Github
## Contributing
We welcome contributions to the project! If you would like to contribute, please follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name:
```bash
git checkout -b my-feature-branch
```
3. Make your changes and commit them with clear commit messages:
```bash
git commit -m "Add new feature"
```
4. Push your changes to your forked repository:
```bash
git push origin my-feature-branch
```
5. Open a Pull Request on the original repository, describing your changes and the motivation behind them.
- I'll review your Pull Request and provide feedback. Thank you for your contributions!
## Author
Created by [Alberto Linde](https://www.albertolinde.com)
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Repository
- [GitHub Repository](https://github.com/AlbertoLinde/git-contribution-extractor)
## Bugs and Issues
If you encounter any bugs or issues, please open an issue in the [GitHub Issues page](https://github.com/AlbertoLinde/git-contribution-extractor/issues).