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. 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:

npm install -g git-contribution

Usage

To run the tool, simply use the command:

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:

   git checkout -b my-feature-branch

3. Make your changes and commit them with clear commit messages:

   git commit -m "Add new feature"

4. Push your changes to your forked repository:

   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

License

This project is licensed under the MIT License. See the LICENSE file for details.

Repository

• GitHub Repository

Bugs and Issues

If you encounter any bugs or issues, please open an issue in the GitHub Issues page.