Chrono Git

Chrono Git is a Visual Studio Code extension designed to track and mirror your GitHub contributions efficiently. It automates the process of mirroring commits from selected repositories to a designated mirror repository, ensuring your contributions are always visible on your GitHub profile.

Features

• Authenticate with GitHub: Seamless OAuth authentication to securely access your GitHub account.

• Select Repositories: Choose which repositories to mirror commits from using a user-friendly interface.

• Commit Mirroring: Automatically sync commits from the selected repositories to a designated mirror repository.

• Background Sync: Commits are synced at regular intervals without manual intervention.

• Command Palette Integration: All core actions are accessible via the VS Code command palette.Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

Requirements

• A GitHub account.

• A GitHub personal access token with necessary permissions (if required for certain configurations).

Installation

1. Install the chrono-git extension from the Visual Studio Code Marketplace.

2. Open the command palette (Ctrl+Shift+P or Cmd+Shift+P on macOS) and search for Chrono Git commands to get started.

Getting Started

1. Authenticate with GitHub: Run Chrono Git: Authenticate with GitHub from the command palette to link your GitHub account.

2. Select Repositories: Use Chrono Git: Select Repositories for Mirroring to choose repositories whose commits you want to mirror.

3. Start Syncing: The extension will automatically sync commits to the designated mirror repository (chrono-git-mirror by default). You can manually trigger a sync with Chrono Git: Sync Now.

Extension Settings

This extension contributes the following settings:

1. chronoGit.mirrorRepo: The name of the repository where commits will be mirrored. Default is commit-mirror.

2. chronoGit.mirrorRepoOwner: The owner of the mirror repository. If not specified, defaults to the authenticated user.

To configure these settings, go to File > Preferences > Settings (or Code > Preferences > Settings on macOS) and search for chronoGit.

Commands

• Chrono Git: Authenticate with GitHub: Authenticate your GitHub account.

• Chrono Git: Select Repositories for Mirroring: Select repositories to mirror commits from.

• Chrono Git: Sync Now: Manually trigger commit mirroring.

Known Issues

• None currently reported. Please report issues on the GitHub repository.

Release Notes

1.0.0

• Initial release of Chrono Git.

• Core features: authentication, repository selection, commit mirroring, and background sync.

1.0.1 (Planned)

• Enhanced UI/UX for repository selection.

• Notifications for sync status.

• Support for private mirror repositories.

---

For Developers

Debugging

To debug the extension locally:

1. Clone the repository.

2. Open the project in VS Code.

3. Run the Launch Extension task in the debug panel.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.

License

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

Enjoy using Chrono Git!