OpenSourceFellows/amplify

[Architecture] GitEmote - Comment Action

eprice555 opened this issue · 2 comments

Courtesy of @rcmtcristian

Part of the OSS Architecture track

User Story:

As a developer, I want to use emojis in commit messages so that I can easily identify the purpose or intention of a commit by simply looking at the emojis used.

About

This workflow triggers on every new pull request to the specified branch (in this example, the main branch). It checks commit messages for the presence of keywords in this instance Conventional Commits and comments a reacting image fetched from the Emojik API to the comment section of the pull request.

Task

  • [] In the .yaml workflow files of our project, configure the PR Emote Action to work seamlessly.
  • [] While configuring, make sure to add inline comments to clarify the setup steps.

For a more streamlined process, you can consider using the Copilot prompt: "How to create a GitHub Action similar to the PR Emote Generator?"

Alternatively, you can also review the commented code in the PR Emote Action Repository for guidance.

Resources: