Skip to content

Conversation

@revolter
Copy link
Contributor

Why:

To prevent incorrect interpretations of the descriptions of the YAML structure required for checkboxes (like in #41190).

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

All the other types both explain the validations key and then showcase it, but the checkboxes one does not showcase it.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copilot AI review requested due to automatic review settings November 18, 2025 20:37
@revolter revolter force-pushed the fix/add-missing-validations-showcase-to-checkboxes-examples branch from ccdad8f to 90ad27c Compare November 18, 2025 20:38
@revolter
Copy link
Contributor Author

Although, it seems like it has no effect 🤔

For example, I have this configuration:

https://github.com/revolter/TestIssueTemplates/blob/main/.github/ISSUE_TEMPLATE/test-template.yml?plain=1

but I was able to create an issue without checking any of them:

revolter/TestIssueTemplates#1

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds missing validations examples to checkbox form elements in the GitHub form schema documentation to maintain consistency with other input types and prevent misinterpretation of the YAML structure.

Key Changes:

  • Added validations section to two checkbox examples in the documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +53 to +54
validations:
required: true
Copy link

Copilot AI Nov 18, 2025

Choose a reason for hiding this comment

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

The checkbox already has required: true at the item level (line 52). Adding a top-level validations.required may be redundant or confusing. Clarify whether both are needed or if one should be removed to avoid duplication.

Suggested change
validations:
required: true

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md fpt
ghec
ghes@ 3.18 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.18 3.17 3.16 3.15 3.14

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@Sharra-writes
Copy link
Contributor

Sharra-writes commented Dec 2, 2025

@revolter I apologize for the very late reply. Between a cold and the American holiday last week, I am trying very hard to catch up with everything. I'm not at all an expert on this, so can you explain to me what you're trying to do and what result you're getting? If needed, I can take it to the appropriate team, but only if I can articulate the question. 😅

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