CodeChronicles

Transforming Your Code into a Timeless Journey!

Effortlessly merge code summaries and watch your GitHub charts shine! This powerful VS Code extension automatically generates summaries of your code and seamlessly merges them into your GitHub repository as commit logs.

---

---

Search "CodeChronicles" on the VS Code Extension or click the above extension link to download.

Table of Contents:

1. Introduction
2. Features
3. Why CodeChronicles?
4. Installation
5. Configuration
6. FAQ's
7. Contributing
8. License

Introduction:

Every line of code has a story, and every commit builds your legacy. CodeChronicles, a VS Code extension, ensures you never lose track of your progress. It automatically generates summaries of your code, merges them into your GitHub repository, keeps your GitHub chart alive, and lets you focus on what truly matters—creating something extraordinary.

Start documenting your coding adventures effortlessly, one commit at a time, and watch your story unfold in the chronicles of GitHub!

Head to Installation to setup CodeChronicles!

Want to contribute?, check out CONTRIBUTION.md!

Features:

• Code Summaries: Automatically generates simple summaries of your workspace, describing what the files and code do, every 25 minutes.
• GitHub Integration: Commits and merges these summaries into your GitHub repository automatically.
• Keeps GitHub Active: Helps keep your GitHub contribution chart active whenever you code, accurately reflecting when and what you worked on.
• Lightweight Logging: Creates a Markdown file with a brief overview of your workspace without going into every detail.
• Customizable Timing: Adjust the summary interval to suit your workflow.

Why CodeChronicles?

• Keep GitHub Charts Active: The main benefit of CodeChronicles is keeping your GitHub contribution chart updated by merging summaries, ensuring your coding streaks and activity are accurately recorded.
• Track Your Coding Journey: Easily look back at your repository to see when and what you worked on, with summaries providing a quick understanding of your workspace.
• Focus on Coding: CodeChronicles handles summary creation and merging automatically, so you can focus on coding without worrying about manually updating GitHub activity.

Installation:

• Requirements:

  For CodeChronicles to function properly, you will need the following installed on your system:
  • Git
  • GitHub Copilot (VS Code Extension)

If you have all the requirements installed already, head to Configuration.

The installation might take a moment, but it's beginner-friendly and a one-time process. Once done, your GitHub charts will shine effortlessly!

• Installing Requirements: Follow the steps below to ensure all necessary requirements are installed and configured properly:

  • Git

    1. Install Git from here.
    2. During the Git installation, simply click 'Next' until the installation is complete.
    3. After completing the Git installation, go to your GitHub profile, click on your avatar in the top-right corner, navigate to Settings, and select Emails from the left-hand menu.
    4. Now, copy the noreply email, which will look something like this: 123456789+Quanta-Naut@users.noreply.github.com. The one highlighted in red box.

    

    5. Open the command prompt and run the following commands to set your Git username and email:

       git config --global user.name "Your Name" git config --global user.email "noreply_email@users.noreply.github.com"

       In place of Your Name, add your name, and in place of noreply_email@users.noreply.github.com, paste the noreply email you copied.

    6. That's all with Git.

  • GitHub Copilot

    1. Open VS Code, go to the Extensions view, and install GitHub Copilot.

    

    2. Click on the Copilot icon in the bottom right of VS Code, and you will be prompted to log in to GitHub. Click 'Allow' and log in to complete the process.

    

    3. Click on Accounts to confirm your login.

    

Configuration:

1. Either through File > Open Folder or from the welcome page, open a folder in your workspace in VS Code.

   

2. Open GitHub in your browser, create a new public repository, and then copy the repository link. It must be similar to (https://github.com/Quanta-Naut/CodeChronicles) or (https://github.com/Quanta-Naut/CodeChronicles.git).

3. Now, go back to VS Code and press F1 or Ctrl + Shift + P, and type **`CodeChronicles: Configure

   

4. Once you hit Enter, you will be prompted to enter your repository link. Paste the link and make sure to add .git at the end, then hit Enter. Your link should look something like this: https://github.com/Quanta-Naut/CodeChronicles.git (with .git at the end).

   

5. Now, a window will appear asking you to sign in to GitHub. Please click Sign In, and you will be redirected to your browser to log in.

   

6. If you followed all the above steps correctly, you will be greeted with the message: CodeChronicles: Successfully Configured Repository.

   

7. Just to test, create a program file (e.g., main.py), type a simple program like print("Hello World"), and save the file.

8. Now, press F1 or Ctrl + Shift + P, and type CodeChronicles: Generate Summary and hit Enter

   

9. Make sure you have internet connection.

10. Wait for 10-15 seconds. If everything is set up correctly, you will receive a notification saying CodeChronicles: Progress has been merged with the GitHub repository.

    

**If you've reached this far, Congratulations! Your GitHub chart is about to look beautiful!

Please follow the steps below. Here are the commands to use CodeChronicles:

Commands:

All the commands listed can be executed by pressing F1 or Ctrl + Shift + P.

1. CodeChronicles: Set Interval Set Interval command allows you to set the interval at which the summary should be merged. The range of the interval is from 25 minutes to 80 minutes. Every x minutes (within the range of 25 to 80 minutes), the summary is merged.

   Hit Enter. And type in a valid minute between 25 - 80 minutes

2. CodeChronicles: Show Repository Show Repository command allows you to view both the GitHub repository and the local repository.

   

   Hit Enter. Here in the dialog box below, you can select:

   • GitHub Repo: Opens the GitHub repository in your browser where the summary is stored.
   • Local Repo: Opens the folder on your system where all the summaries are stored locally.

   

3. CodeChronicles: Clear Configuration Clear Configuration removes the stored GitHub repository and deletes the local folder where all summaries are stored (located in the local documents folder). This can be used if any mistakes are made during the setup.

   

   All data gets cleared.

   

4. CodeChronicles: Configure Configure command is used to set up the GitHub repository where all the summary merging happens. In the background, it automatically creates a local folder to store all the summaries.

   

   If the configuration is already set, the command will ask for confirmation:

   • Yes (Y): Proceeds with reconfiguration.
   • No (N): Cancels the configuration process."

   

   While configuring, you will be prompted to enter your GitHub repository link. Ensure the link ends with .git (e.g., https://github.com/Quanta-Naut/CodeChronicles.git)

   

   If everything is configured correctly, you will receive the message: CodeChronicles: Successfully Configured Repository.

   

5. CodeChronicles: Generate Summary Generate Summary command forces the generation of the summary and merges it to the GitHub repository, bypassing the set interval.

   

   If everything is configured correctly, you will receive the following message: CodeChronicles: Progress has been merged with the GitHub repository.

   

Contributors:

• 

Want to contribute?, check out CONTRIBUTION.md! Will be updated soon!!.

---

License

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