git-donkey

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2024 License: MIT Imports: 1 Imported by: 0

README

git-donkey 🐴

A Donkey Don to help you manage your local git branches/repositories.

Introduction:

git-donkey is a tool designed to help developers keep their local git branches synchronized with the remote repository. It automates the process of searching through your local repositories & show you the updates and push help push untracked changes to the remote repo. ensuring that your local & remote branch is always up-to-date.

🚀 Getting started

https://github.com/bupd/git-donkey/assets/89722848/52f90de7-a429-4d34-97bc-078b3ac223db

Prerequisites

Please make sure you installed golang.

Installation

To install git-donkey, you need to have Go installed on your system. Then, follow these steps:

go install github.com/bupd/git-donkey@latest

Usage

Once installed, you can use git-donkey with the following command:

git-donkey scan

scan command scans all of your local directories for github repos.

💻 Technologies

  • Golang
  • cobra cli
  • gogit

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Open a Pull Request. Please ensure that your code adheres to the project's coding standards and includes appropriate tests.

License

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

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern

Documentation

Overview

Copyright © 2024 Prasanth Bupd <bupdprasanth@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL