Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: pin modules plus add logo module #8

Merged

Conversation

rolasotelo
Copy link
Contributor

@rolasotelo rolasotelo commented Mar 17, 2024

Added Features

Pinned Modules

  • Functionality: Modules can now be pinned to the top of every page, enhancing visibility and access.
  • Configuration: Set the Pinned property to true in a module's configuration to activate this feature.

New Logo Module

  • Purpose: Introduces a visually appealing ASCII art logo at the start of the goodcommit process, utilizing the pinned modules feature for consistent display.
  • Implementation: Uses huh.Note for displaying ASCII art. Configured as active and pinned by default for optimal branding.

Documentation Enhancements

  • Configuring Modules: The README.md now includes a new section detailing how to configure modules. It outlines available fields (name, page, position, pinned, active, path, priority, checkpoint) and their impact on module behavior.
  • Examples Provided: Demonstrates various configurations, such as basic module setup, pinning a module, and using external configuration files, to guide users in customizing the goodcommit form.

Impact

This update improves the tool's flexibility and usability, allowing users to add things like branding and new workflows to the goodcommit form.

@rolasotelo
Copy link
Contributor Author

@rolasotelo rolasotelo self-assigned this Mar 17, 2024
@rolasotelo rolasotelo merged commit 5f7d187 into main Mar 17, 2024
@rolasotelo rolasotelo deleted the CU-869430vwe_feat-pin-modules-to-appear-in-every-page branch March 17, 2024 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant