From fed0a46eea0af63b2378179ac8826b2e8a19a6f0 Mon Sep 17 00:00:00 2001 From: Ian Skelskey Date: Sun, 15 Dec 2024 23:25:19 -0500 Subject: [PATCH] Enhance markdown consistency in docs and changelog Refactor markdown files for consistency: - Indent lists with consistent spacing - Align formatting for easier readability across multiple documents Release-Note: Improve consistency in documentation and changelog formatting Signed-off-by: Ian Skelskey --- CHANGELOG.md | 70 ++++++++++++++++++++++++++-------------------------- README.md | 28 ++++++++++----------- 2 files changed, 49 insertions(+), 49 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 82200de..67a8db6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,12 +6,12 @@ This file is written automatically by the [version bump script](version-bump.ts) ### Changelog Summary -- Enhanced version bump and changelog handling. -- Improved commit flow with Launchpad bug integration. -- Enhanced commit message handling by improved sanitization logic, specifically replacing newline characters with escape sequences for better multi-line support. -- Refactored code for improved readability and error handling. -- Utilized temporary files for git commit message construction. -- General code prettification and refactoring for better code organization and functionality. +- Enhanced version bump and changelog handling. +- Improved commit flow with Launchpad bug integration. +- Enhanced commit message handling by improved sanitization logic, specifically replacing newline characters with escape sequences for better multi-line support. +- Refactored code for improved readability and error handling. +- Utilized temporary files for git commit message construction. +- General code prettification and refactoring for better code organization and functionality. ## [0.1.1] - 2024-11-16 @@ -19,9 +19,9 @@ This file is written automatically by the [version bump script](version-bump.ts) ### Changelog Summary -- Enhanced commit workflow: - - Added a feedback loop for improved user interaction. - - Introduced an option to unstage changes. +- Enhanced commit workflow: + - Added a feedback loop for improved user interaction. + - Introduced an option to unstage changes. ## [0.1.2] - 2024-11-17 @@ -31,35 +31,35 @@ This file is written automatically by the [version bump script](version-bump.ts) #### New Features -- Added test job to GitHub Actions workflow. -- Enhanced CLI options and updated version handling in evergit. +- Added test job to GitHub Actions workflow. +- Enhanced CLI options and updated version handling in evergit. #### Improvements -- Added code coverage reports and refactored tests -- Implemented error handling for model settings with a list of available models -- Updated README with npm install and usage instructions. -- Added changelog generation details to the `CHANGELOG.md`. -- Introduced option for staging all files during commit. -- Added `ts-prune` to check for unused exports. +- Added code coverage reports and refactored tests +- Implemented error handling for model settings with a list of available models +- Updated README with npm install and usage instructions. +- Added changelog generation details to the `CHANGELOG.md`. +- Introduced option for staging all files during commit. +- Added `ts-prune` to check for unused exports. #### Refactoring -- Refactored diff retrieval to exclude specific files. +- Refactored diff retrieval to exclude specific files. #### Code Quality -- Prettified code in multiple instances. +- Prettified code in multiple instances. #### Maintenance -- Added `.VSCodeCounter/` to `.gitignore` for a cleaner repository. -- Removed generated coverage files from the repository and updated `.gitignore` accordingly. -- Cleaned up coverage files and ignored them in future commits. +- Added `.VSCodeCounter/` to `.gitignore` for a cleaner repository. +- Removed generated coverage files from the repository and updated `.gitignore` accordingly. +- Cleaned up coverage files and ignored them in future commits. #### Fixes -- Added a success message after the commit operation is performed. +- Added a success message after the commit operation is performed. ## [0.1.3] - 2024-11-19 @@ -67,21 +67,21 @@ This file is written automatically by the [version bump script](version-bump.ts) ### Changelog Summary -- **Enhancements:** +- **Enhancements:** - - Improved buffer handling in the `getDiffForStagedFiles` function. - - Enhanced the CLI main function and added corresponding tests. + - Improved buffer handling in the `getDiffForStagedFiles` function. + - Enhanced the CLI main function and added corresponding tests. -- **Testing:** +- **Testing:** - - Added integration tests for Git utilities. + - Added integration tests for Git utilities. -- **Code Quality:** +- **Code Quality:** - - Prettified codebase for improved readability. + - Prettified codebase for improved readability. -- **Merges:** - - Merged branch 'dev' from the repository. +- **Merges:** + - Merged branch 'dev' from the repository. ## [0.1.4] - 2024-12-16 @@ -89,6 +89,6 @@ This file is written automatically by the [version bump script](version-bump.ts) # Changelog Summary -- Refactored AI utility to use Axios instead of OpenAI client. -- Improved code readability by applying code formatting (Prettified Code). -- Merged changes from the 'main' branch into 'dev'. +- Refactored AI utility to use Axios instead of OpenAI client. +- Improved code readability by applying code formatting (Prettified Code). +- Merged changes from the 'main' branch into 'dev'. diff --git a/README.md b/README.md index cfd0e99..9ac01f1 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,17 @@ An AI-powered Git helper for the Evergreen ILS project. Evergit uses OpenAI’s ## Features -- Generate commit messages using OpenAI's LLM models. -- Automatically reference Launchpad bugs in commit messages. -- Automatically sign off commits with the user's name and email. -- Select files to stage for commit. -- Use different models by specifying the model name as an argument. +- Generate commit messages using OpenAI's LLM models. +- Automatically reference Launchpad bugs in commit messages. +- Automatically sign off commits with the user's name and email. +- Select files to stage for commit. +- Use different models by specifying the model name as an argument. ## Requirements -- `Node.js`, `npm`, and `Git` must be installed on your system. -- OpenAI API key (stored in the `OPENAI_API_KEY` environment variable) -- A launchpad account is required to reference bugs in commit messages. +- `Node.js`, `npm`, and `Git` must be installed on your system. +- OpenAI API key (stored in the `OPENAI_API_KEY` environment variable) +- A launchpad account is required to reference bugs in commit messages. ## Installation @@ -50,20 +50,20 @@ Generates a commit message using a LLM model from OpenAI that follows the Evergr evergit commit # Uses the default model and prompts the user to select files to stage ``` -- Prompts the user to select files to stage. -- Prompts the user for a Launchpad bug number. - - References the bug name, description and conversation when generating the commit message using the Launchpad API. -- Automatically signs off the commit with the user's name and email from the git configuration. +- Prompts the user to select files to stage. +- Prompts the user for a Launchpad bug number. + - References the bug name, description and conversation when generating the commit message using the Launchpad API. +- Automatically signs off the commit with the user's name and email from the git configuration. ##### Options -- `-m, --model `: Use a specific model to generate the commit message. +- `-m, --model `: Use a specific model to generate the commit message. ```bash evergit commit --model # Uses a specific model ``` -- `-a, --all`: Stage all modified files for commit. +- `-a, --all`: Stage all modified files for commit. ```bash evergit commit --all # Stages all modified files