Skip to content

Conversation

@lucasbonanni
Copy link

@lucasbonanni lucasbonanni commented Dec 3, 2025

Inspired by the Conventional Comments project.

Copy link
Collaborator

@smeech smeech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A simple single trigger, making use of anchors and aliases.

No script/shell or potentially malicious code.

I've made a few "nitpick" comments beyond the "homepage:` requirement!

description: A simple package to show how to create your own one!
version: 0.1.0
author: Lucas Bonanni
tags: ["conventional comments", "github"]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you kindly add a homepage: key and value, please? We've had difficulty merging some packages without it.
homepage: https://github.com/lucasbonanni/hub/tree/main would do, although you may have a broader homepage of your own.

@@ -0,0 +1,30 @@
# Conventional Comments Match Configuration
# Inspired by https://conventionalcomments.org/
variables:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the docs, would you name this section anchors:, please?


matches:
- trigger: ":ccc"
form: '[[label]] ([[decorations]]): '
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of decorations for both a variable and an anchor/alias name is a little confusing. labels/label is marginally better.

Would you mind using, for example, decorations_list and labels_list, for the anchors/aliases?

decorations:
type: choice
values: *decorations
description: "Single line comment format // Comment"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this line for?

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.

2 participants