Skip to content

Latest commit

 

History

History
69 lines (64 loc) · 3.2 KB

TODO.md

File metadata and controls

69 lines (64 loc) · 3.2 KB
Raw

TODO

This document outlines the upcoming features and improvements for the ai_diff_commit script. Once entire features are implemented, I will move them to the Completed Features section. If the document becomes bloated, the oldest complete features will be removed from the list. The purpose of this document is to keep track of the progress and provide a roadmap for future development. This document is informal and may contain incomplete information.

Upcoming Features:

  • Allow manual editing of commit messages before committing the changes.
  • Add support for Linux and macOS.
    • Linux
    • macOS
  • Add option to select all files within a directory.
  • Option to generate a short commit message without a description. (One-liner)
  • If the remote branch does not exist, create it.
    • i.e. set upstream to the remote branch. maybe just pass the actual git message from this to the user.
  • Add optional organization instructions.
    • Project specific scope definitions and descriptions. e.g. (backend): for backend changes, (frontend): for frontend changes, etc.
    • Any organization-specific instructions.
  • Add an easy way to quit the script.
  • Come up with a better name for the script.
    • ai_diff_commit is too long.
      • comgen
  • OpenAI Assistant for generating commit messages.
  • Make a way to update the OpenAI API key.
    • If the key is invalid, prompt the user to update it.
    • Add a flag to update/remove the key.
  • Decide on a distribution method for the script.
    • Create a release on GitHub.
    • PyPI package.
    • Homebrew formula.
    • AUR package.
    • Snap package.
    • Chocolatey package.
    • npm package.
    • Docker image.
    • GitHub release.
    • Manual installation.
    • Other package manager
  • Release the script to the public as an open-source project.
  • Accept donations for the project.
  • Add contribution guidelines.
  • Add branch protection rules.
  • Create dev branch.
  • Spaces in file names throw errors.
  • Sometimes there are trailing backticks in the commit message.
  • Reference AICommits for inspiration.
    • Study the release strategy.
    • Study the documentation.
    • Compare the features.
  • Meet with Nate about collaboration.

Completed Features:

  • Add documentation for the script.
    • Write a README.md file.
    • Generate documentation using Sphinx or similar tool.
    • Deploy documentation to a website. (Probably GitHub Pages)
    • -h or --help flag to display help information for ai_diff_commit.
  • Create a logo for the script.
  • Add terminal arguments for customization.
    • Add argument for specifying the openai API language model.
    • Add argument for automatically pushing changes.
    • Add argument to automatically add all changes.
    • Add argument for help information.
  • Make automated push optional.
  • Allow the user to specify the files to include in the commit.
  • Automate installation and setup process.
  • Improve interface while still utilizing the command line for simplicity.
  • Clear the terminal before each run.
  • Notify the user of what branch they are on.