docs(contribs): add description field to all contribs YAML files#151
Draft
httpdss wants to merge 1 commit into
Draft
docs(contribs): add description field to all contribs YAML files#151httpdss wants to merge 1 commit into
httpdss wants to merge 1 commit into
Conversation
Add a top-level description field to every YAML file under structkit/contribs/ to provide a quick summary of what each structure generates or configures.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The YAML files under
structkit/contribs/had nodescriptionfield, making it impossible to quickly understand what each structure generates without reading its full content.Solution
Added a top-level
description: >field to every YAML file understructkit/contribs/, consistent with common StructKit conventions. Each description provides a concise, human-readable summary of what the structure creates or configures.Changes
Added
descriptionto all 46 YAML files across:configs/(chglog, codeowners, devcontainer, editor-config, eslint, jshint, kubectl, prettier)github/chatmodes/(plan)github/instructions/(generic)github/prompts/(generic, react-form, security-api, struct)github/templatesgithub/workflows/(codeql, execute-tf-workflow, labeler, pre-commit, release-drafter, run-struct, stale)project/(custom-structures, generic, go, java, n8n, nodejs, python, ruby, rust)prompts/(run-struct-trigger)terraform/apps/(aws-accounts, environments, generic, github-organization, init)terraform/modules/(generic)Testing