phoenix

README

Phoenix

An easy to use CLI to transfert Go projects to an other git repository

---

📖 Table of Contents

• 📖 Table of Contents
• 📍 Overview
• 📦 Features
• 📂 Repository Structure
• 🚀 Getting Started
  • 🔧 Installation
  • 🤖 Running phoenix
• 🤝 Contributing
• 📄 License

---

📍 Overview

An easy to use CLI to transfert Go projects to an other git repository

---

📦 Features

Phoenix allows you to revive a Go project that has changed Git repository.

Phoenix will modify your Go files to use the new module name.

---

📂 Repository Structure

└── phoenix/
    ├── LICENSE
    ├── cmd/
    │   └── root.go
    ├── go.mod
    ├── go.sum
    ├── main.go
    └── pkg/
        └── phoenix/
            ├── phoenix.go
            └── utils.go

---

🚀 Getting Started

🔧 Installation

1. Clone the phoenix repository:

git clone https://github.com/CamilleLange/phoenix

1. Change to the project directory:

cd phoenix

1. Install the dependencies:

go build -o phoenix

🤖 Running phoenix

./phoenix -h

---

🤝 Contributing

Contributions are always welcome! Please follow these steps:

1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

1. Make changes to the project's codebase.
2. Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'Implemented new feature.'

1. Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

1. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

---

📄 License

This project is licensed under the ℹ️ LICENSE-TYPE License. See the LICENSE-Type file for additional info.

---