Skip to content

Conversation

kilasuit
Copy link
Contributor

@kilasuit kilasuit commented May 27, 2025

Pull Request (PR) description

Adding some repo management files

This Pull Request (PR) fixes the following issues

Task list

  • Added an entry to the change log under the Unreleased section of the
    file CHANGELOG.md. Entry should say what was changed and how that
    affects users (if applicable), and reference the issue being resolved
    (if applicable).
  • Resource documentation updated in the resource's README.md.
  • Resource parameter descriptions updated in schema.mof.
  • Comment-based help updated, including parameter descriptions.
  • Localization strings updated.
  • Examples updated.
  • Unit tests updated. See DSC Community Testing Guidelines.
  • Integration tests updated (where possible). See DSC Community Testing Guidelines.
  • Code changes adheres to DSC Community Style Guidelines.

This change is Reviewable

description: Request membership to help maintain this repository.
title: Maintainer Request
labels: ['maintainer-request']
projects: ['repo-management']
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this should add to a project across all of the DSCCommunity & also one that is just in the AzureDevOps repo

This gives repo level and org level visibility very easily without needing to use additional automation or manual tasks to do so

labels: ['maintainer-request']
projects: ['repo-management']
assignees:
- kilasuit
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should be for the core maintainer/maintainers and coudl perhaps be removed due to the codeowners file

validations:
required: true
attributes:
label: Can you provide at least 1 hour per week to help maintain this repository?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This wording was from the PowerShell/PowerShell Working Group Member request form

I kinda want to change this to infer that this should be something like an average of 1hr each .... (what's a sensible timeframe here | week | Month | Year)

Comment on lines +27 to +40
id: accesslevel
validations:
required: true
attributes:
label: Do you require direct write access to the repository?
description: >-
This may be required for some maintainer roles. Please select Yes or No.
If you select No, you will be added as a collaborator and will not have direct write access to the repository.
If you select No, you will **still** be required to create a pull request to make changes to the repository.
If you select Maybe, will discuss with you if this is needed & if so how/when this may be granted in future.
options:
- "Yes"
- "No"
- "Maybe"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is just to show that you can be a maintainer but not need access to the repo with write access to the repo

However, In my experience it's a frustrating experience & this is added as a way to gauge with the following questions what kind of maintainer a requester may want to engage with, both to begin with and in future.

Comment on lines +61 to +80
label: Why do you want to join as a maintainer?
description: Please provide a brief description of why you want to join as a maintainer.
placeholder: >
I want to join as a maintainer because...
validations:
required: true
- type: textarea
attributes:
label: What skills do you bring as a maintainer?
description: Please provide a brief description of what skills you bring to as a maintainer.
placeholder: >
I bring the following skills to as a maintainer...
validations:
required: true
- type: textarea
attributes:
label: Public links to articles, code, or other resources that demonstrate your skills.
description: Please provide public links to articles, code, or other resources that demonstrate your skills.
placeholder: >
I have the following public links to articles, code, or other resources that demonstrate my skills...
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This just helps us get to know the requester

Copy link

coderabbitai bot commented Aug 27, 2025

Walkthrough

Adds CODEOWNERS entry, introduces two new GitHub issue templates (Maintainer Request, Presentation Request), and updates CHANGELOG under Unreleased to record these additions. No source code changes.

Changes

Cohort / File(s) Summary of Changes
CODEOWNERS
.github/CODEOWNERS
Adds owner specification to auto-include @dsccommunity/azuredevsopsdsc on PRs.
Issue Templates
.github/ISSUE_TEMPLATE/maintainerRequest.yml, .github/ISSUE_TEMPLATE/presentationRequest.yml
Adds structured templates for maintainer candidacy and presentation requests with predefined metadata, labels, assignee, and required fields.
Changelog
CHANGELOG.md
Updates Unreleased > Added > RepoManagement section to list new CODEOWNERS and issue templates with issue references.

Sequence Diagram(s)

(no diagrams applicable)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Assessment against linked issues

Objective Addressed Explanation
Add CODEOWNERS File (#42)
Process for joining as a maintainer — add Maintainer Request template (#38)
Add Presentation Request issue template (#41)

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/ISSUE_TEMPLATE/maintainerRequest.yml (1)

9-87: Multiple form-field issues: missing ids, invalid indentation, minor grammar.

  • Indentation: sequence items under body: must be indented two spaces.
  • Missing required id for several textarea blocks (Note, Why, Skills, Links).
  • Minor grammar tweaks and duplicate “If you select No…” lines can be condensed.

Apply:

-body:
-- type: markdown
-  attributes:
-    value: |
-      ## Thank you for your interest in joining as a maintainer of this project.
-
-      ### Please complete the following public form to request we review your application to join as a maintainer.
-- type: dropdown
-  id: time
-  validations:
-    required: true
-  attributes:
-    label: Can you provide at least 1 hour per week spread over the course of the year to help maintain this repository?
-    description: >-
-      Please select Yes or No.
-    options:
-      - "Yes"
-      - "No"
-- type: dropdown
-  id: accesslevel
-  validations:
-    required: true
-  attributes:
-    label: Do you require direct write access to the repository?
-    description: >-
-      This may be required for some maintainer roles. Please select Yes or No.
-      If you select No, you will be added as a collaborator and will not have direct write access to the repository.
-      If you select No, you will **still** be required to create a pull request to make changes to the repository.
-      If you select Maybe, will discuss with you if this is needed & if so how/when this may be granted in future.
-    options:
-      - "Yes"
-      - "No"
-      - "Maybe"
-- type: checkboxes
-  id: type
-  attributes:
-    label: maintainer type
-    description: >-
-      Please select the type of maintainer you are interested in becoming.
-      For more information on the types of maintainers, please see the 
-      Different Types of Maintainer blog post
-      https://blog.kilasuit.org/2025/08/01/different-types-of-code-maintainer/
-    options:
-      - label: "Code Maintainer"
-      - label: "Issue Triage"
-      - label: "Code Review"
-      - label: "Documentation"
-      - label: "Testing"
-      - label: "Content Creation"
-      - label: "Other"
-- type: textarea
-  attributes:
-    label: "Note"
-    value: |
-      ## ⚠️ This form is public. Do not provide any private or proprietary information. ⚠️
-- type: textarea
-  attributes:
-    label: Why do you want to join as a maintainer?
-    description: Please provide a brief description of why you want to join as a maintainer.
-    placeholder: >
-      I want to join as a maintainer because...
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: What skills do you bring as a maintainer?
-    description: Please provide a brief description of what skills you bring to as a maintainer.
-    placeholder: >
-      I bring the following skills to as a maintainer...
-  validations:
-    required: true
-- type: textarea
-  attributes:
-    label: Public links to articles, code, or other resources that demonstrate your skills.
-    description: Please provide public links to articles, code, or other resources that demonstrate your skills.
-    placeholder: >
-      I have the following public links to articles, code, or other resources that demonstrate my skills...
-  validations:
-    required: true
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Thank you for your interest in joining as a maintainer of this project.
+
+        ### Please complete this public form to request a review of your application.
+  - type: dropdown
+    id: time
+    validations:
+      required: true
+    attributes:
+      label: Can you provide ~1 hour per week (on average) over a year?
+      description: Please select Yes or No.
+      options:
+        - "Yes"
+        - "No"
+  - type: dropdown
+    id: accesslevel
+    validations:
+      required: true
+    attributes:
+      label: Do you require direct write access to the repository?
+      description: >-
+        This may be required for some maintainer roles.
+        If you select No, you will be added as a collaborator without write access
+        and will still create pull requests for changes.
+        If you select Maybe, we will discuss whether/when this may be granted.
+      options:
+        - "Yes"
+        - "No"
+        - "Maybe"
+  - type: checkboxes
+    id: type
+    attributes:
+      label: Maintainer type
+      description: >-
+        Select the areas you’re interested in. For context, see:
+        https://blog.kilasuit.org/2025/08/01/different-types-of-code-maintainer/
+      options:
+        - label: "Code Maintainer"
+        - label: "Issue Triage"
+        - label: "Code Review"
+        - label: "Documentation"
+        - label: "Testing"
+        - label: "Content Creation"
+        - label: "Other"
+  - type: textarea
+    id: note
+    attributes:
+      label: "Note"
+      value: |
+        ## ⚠️ This form is public. Do not provide any private or proprietary information. ⚠️
+  - type: textarea
+    id: why
+    attributes:
+      label: Why do you want to join as a maintainer?
+      description: Briefly describe your motivation to join as a maintainer.
+      placeholder: >
+        I want to join as a maintainer because...
+    validations:
+      required: true
+  - type: textarea
+    id: skills
+    attributes:
+      label: What skills do you bring as a maintainer?
+      description: Briefly describe the skills you bring as a maintainer.
+      placeholder: >
+        I bring the following skills as a maintainer...
+    validations:
+      required: true
+  - type: textarea
+    id: links
+    attributes:
+      label: Public links to articles, code, or other resources that demonstrate your skills.
+      description: Provide public links that demonstrate your skills.
+      placeholder: >
+        Links to articles, code, talks, or other resources...
+    validations:
+      required: true
♻️ Duplicate comments (1)
.github/ISSUE_TEMPLATE/maintainerRequest.yml (1)

4-4: Repository label may not exist.

Past comment notes “Don’t have this label right now”. Either create the maintainer-request label or switch to an existing one to avoid silent failures in issue triage.

🧹 Nitpick comments (3)
.github/CODEOWNERS (1)

1-3: Optional: note on branch protection interaction.

CODEOWNERS requests reviews on matching paths; to enforce blocking merges until code owners approve, ensure "Require review from Code Owners" is enabled in branch protection for main.

CHANGELOG.md (1)

10-13: Align with repo’s changelog style (≤2 items under a change type) and wording.

Guidelines limit to two items per change type. Consolidate the two issue-template bullets and prefer “Repository management” over “RepoManagement”.

Apply:

-- RepoManagement
-  - Added Codeowners File - [#42](https://github.com/dsccommunity/AzureDevOpsDsc/issues/42)
-  - Added Maintainer Request Template - [#38](https://github.com/dsccommunity/AzureDevOpsDsc/issues/38)
-  - Added Presentation Request Template - [#41](https://github.com/dsccommunity/AzureDevOpsDsc/issues/41)
+- Repository management
+  - Added CODEOWNERS file - [#42](https://github.com/dsccommunity/AzureDevOpsDsc/issues/42)
+  - Added issue templates (Maintainer Request, Presentation Request) - 
+    [#38](https://github.com/dsccommunity/AzureDevOpsDsc/issues/38), 
+    [#41](https://github.com/dsccommunity/AzureDevOpsDsc/issues/41)

Optional: wrap long lines to ≤80 chars to satisfy the Markdown style guide.

.github/ISSUE_TEMPLATE/maintainerRequest.yml (1)

5-5: Verify projects assignment format.

Use org/project-number or a full URL. The current value is likely ignored. See the presentation template comment for a CLI snippet to list org projects.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • Jira integration is disabled
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between bd9ab0d and a23bd80.

📒 Files selected for processing (4)
  • .github/CODEOWNERS (1 hunks)
  • .github/ISSUE_TEMPLATE/maintainerRequest.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/presentationRequest.yml (1 hunks)
  • CHANGELOG.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

  • Command: Public command
  • Function: Private function
  • Resource: DSC class-based resource

Build & Test Workflow

  • Run project scripts in PowerShell from repository root
  • Build after source changes: .\build.ps1 -Tasks build
  • Test workflow: Build → Invoke-Pester -Path @('<test paths>') -Output Detailed
  • New session required after class changes

File Organization

  • Public commands: source/Public/{CommandName}.ps1
  • Private functions: source/Private/{FunctionName}.ps1
  • Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
  • Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

  • Follow guidelines over existing code patterns
  • Always update CHANGELOG.md Unreleased section
  • Localize all strings using string keys; remove any orphaned string keys
  • Check DscResource.Common before creating private functions
  • Separate reusable logic into private functions
  • Add unit tests for all commands/functions/resources
  • Add integration tests for all public commands and resources

Files:

  • CHANGELOG.md
**/*.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

  • Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
  • Use 2 spaces for indentation
  • Use '1.' for all items in ordered lists (1/1/1 numbering style)
  • Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
  • Empty lines required before/after code blocks and headings (except before line 1)
  • Escape backslashes in file paths only (not in code blocks)
  • Code blocks must specify language identifiers

Text Formatting

  • Parameters: bold
  • Values/literals: inline code
  • Resource/module/product names: italic
  • Commands/files/paths: inline code

Files:

  • CHANGELOG.md
CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

  • Always update the Unreleased section in CHANGELOG.md
  • Use Keep a Changelog format
  • Describe notable changes briefly, ≤2 items per change type
  • Reference issues using format #<issue_number>
  • No empty lines between list items in same section
  • Do not add item if there are already an existing item for the same change

Files:

  • CHANGELOG.md
🪛 YAMLlint (1.37.1)
.github/ISSUE_TEMPLATE/presentationRequest.yml

[error] 1-1: wrong new line character: expected \n

(new-lines)


[warning] 9-9: wrong indentation: expected 2 but found 0

(indentation)

.github/ISSUE_TEMPLATE/maintainerRequest.yml

[error] 1-1: wrong new line character: expected \n

(new-lines)


[warning] 9-9: wrong indentation: expected 2 but found 0

(indentation)


[error] 47-47: trailing spaces

(trailing-spaces)

🪛 LanguageTool
CHANGELOG.md

[grammar] ~10-~10: There might be a mistake here.
Context: ...Unreleased] ### Added - RepoManagement - Added Codeowners File - [#42](https://gi...

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: dsccommunity.AzureDevOpsDsc (Build Package Module)
🔇 Additional comments (2)
.github/CODEOWNERS (1)

1-3: Fix .github/CODEOWNERS syntax and team-slug typo

The current entry is non-functional because CODEOWNERS requires a file-path pattern before one or more owners, and the team slug appears to be misspelled.

Locations needing attention:

  • .github/CODEOWNERS (Lines 1–3): owner entry lacks a path pattern.
  • Team slug: @dsccommunity/azuredevsopsdsc → should be @dsccommunity/azuredevopsdsc.

Suggested patch:

-# Auto-include these teams/individuals on all PRs.
-
-@dsccommunity/azuredevsopsdsc
+# Auto-request review from Azure DevOps DSC maintainers for all PRs.
+* @dsccommunity/azuredevopsdsc

Next steps:

  • Confirm the exact team slug in your org (via GitHub UI: Organization Settings → Teams → Azure DevOps DSC, or with the GitHub CLI:
    gh team list --org dsccommunity --json slug | jq -r '.[].slug').
  • If you only want auto-reviews on specific paths, replace * with a scoped pattern (e.g., docs/** @dsccommunity/azuredevopsdsc).
.github/ISSUE_TEMPLATE/presentationRequest.yml (1)

3-5: Tidy metadata: fix trailing space and use a valid project reference

  • Remove the extra space at the end of the title string.
  • Replace the placeholder in projects with a real project identifier (either org/project-number or the full project URL). Unfortunately, the classic-projects API is deprecated and cannot be listed automatically; please verify the correct project number or URL in the GitHub UI.

Suggested update:

-title: "📖 Presentation Request: <where at...?> "
+title: "📖 Presentation Request: <where at...?>"
-projects: ["AzureDevOpsDSC-repo-management"]
+# TODO: replace with a real project reference
+projects: ["dsccommunity/42"]  # e.g. "https://github.com/orgs/dsccommunity/projects/42"

Comment on lines +8 to +41
body:
- type: textarea
id: PresentationRequest
attributes:
label: Summary
description: Please a link (ideally via a form)
placeholder: |
Are you requesting me to present about this?
Do you want to present about this?
validations:
required: true
- type: textarea
id: ContactLink
attributes:
label: Contact link
description: How to get in contact with you
placeholder: |
Ideally you should learn about PGP & provide me your contact details via an encrypted message that can be decrypted only by you and me
My Current PGP key is on my github profile readme.
Ideally using your gh handle and this repo as a password i.e. kilasuit/DocTypes
Don't know about PGP? there are other services that you can use like temp.pm & intime I will build & run my own
Want me to walk through PGP with you? let me know and
validations:
required: true
- type: textarea
id: AdditionalInfo
attributes:
label: Anything else?
description: |
Any other comments, like did you like this Project?
Have you used this Project & linked projects to help you with your work?
If no other comments, please put N/A or None
validations:
required: true
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

YAML indentation under body: is invalid; the issue form will not render.

Sequence items under body: must be indented two spaces. The current top-level - type: entries break parsing.

Apply:

-body:
-- type: textarea
-  id: PresentationRequest
-  attributes:
-    label: Summary
-    description: Please a link (ideally via a form)
-    placeholder: |
-      Are you requesting me to present about this?
-      Do you want to present about this?
-  validations:
-    required: true
-- type: textarea
-  id: ContactLink
-  attributes:
-    label: Contact link
-    description: How to get in contact with you
-    placeholder: |
-      Ideally you should learn about PGP & provide me your contact details via an encrypted message that can be decrypted only by you and me
-      My Current PGP key is on my github profile readme.
-      Ideally using your gh handle and this repo as a password i.e. kilasuit/DocTypes
-      Don't know about PGP? there are other services that you can use like temp.pm & intime I will build & run my own
-      Want me to walk through PGP with you? let me know and
-  validations:
-    required: true
-- type: textarea
-  id: AdditionalInfo
-  attributes:
-    label: Anything else?
-    description: |
-      Any other comments, like did you like this Project?
-      Have you used this Project & linked projects to help you with your work?
-      If no other comments, please put N/A or None
-  validations:
-    required: true
+body:
+  - type: textarea
+    id: PresentationRequest
+    attributes:
+      label: Summary
+      description: Please provide a link (ideally to a form).
+      placeholder: |
+        Are you requesting me to present about this?
+        Do you want to present about this?
+    validations:
+      required: true
+  - type: textarea
+    id: ContactLink
+    attributes:
+      label: Contact link
+      description: How can I contact you?
+      placeholder: |
+        Share a public contact link (e.g., email, website, social). 
+        If you prefer encryption, provide your PGP public key and a method 
+        to send an encrypted message.
+    validations:
+      required: true
+  - type: textarea
+    id: AdditionalInfo
+    attributes:
+      label: Anything else?
+      description: |
+        Any other comments, e.g., how you plan to use this project.
+        If no other comments, write N/A or None.
+    validations:
+      required: true
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
body:
- type: textarea
id: PresentationRequest
attributes:
label: Summary
description: Please a link (ideally via a form)
placeholder: |
Are you requesting me to present about this?
Do you want to present about this?
validations:
required: true
- type: textarea
id: ContactLink
attributes:
label: Contact link
description: How to get in contact with you
placeholder: |
Ideally you should learn about PGP & provide me your contact details via an encrypted message that can be decrypted only by you and me
My Current PGP key is on my github profile readme.
Ideally using your gh handle and this repo as a password i.e. kilasuit/DocTypes
Don't know about PGP? there are other services that you can use like temp.pm & intime I will build & run my own
Want me to walk through PGP with you? let me know and
validations:
required: true
- type: textarea
id: AdditionalInfo
attributes:
label: Anything else?
description: |
Any other comments, like did you like this Project?
Have you used this Project & linked projects to help you with your work?
If no other comments, please put N/A or None
validations:
required: true
body:
- type: textarea
id: PresentationRequest
attributes:
label: Summary
description: Please provide a link (ideally to a form).
placeholder: |
Are you requesting me to present about this?
Do you want to present about this?
validations:
required: true
- type: textarea
id: ContactLink
attributes:
label: Contact link
description: How can I contact you?
placeholder: |
Share a public contact link (e.g., email, website, social).
If you prefer encryption, provide your PGP public key and a method
to send an encrypted message.
validations:
required: true
- type: textarea
id: AdditionalInfo
attributes:
label: Anything else?
description: |
Any other comments, e.g., how you plan to use this project.
If no other comments, write N/A or None.
validations:
required: true
🧰 Tools
🪛 YAMLlint (1.37.1)

[warning] 9-9: wrong indentation: expected 2 but found 0

(indentation)

🤖 Prompt for AI Agents
In .github/ISSUE_TEMPLATE/presentationRequest.yml around lines 8 to 41, the YAML
sequence items under the body key are not indented correctly (the "- type:"
entries are at the same level as body), which breaks parsing and prevents the
form from rendering; fix it by nesting the form fields as array items under body
by adding two spaces before each sequence marker and all of their child lines so
each "- type:" and its attributes/validations are indented two spaces relative
to the body key, ensuring consistent indentation for each field block.

Comment on lines +13 to +29
description: Please a link (ideally via a form)
placeholder: |
Are you requesting me to present about this?
Do you want to present about this?
validations:
required: true
- type: textarea
id: ContactLink
attributes:
label: Contact link
description: How to get in contact with you
placeholder: |
Ideally you should learn about PGP & provide me your contact details via an encrypted message that can be decrypted only by you and me
My Current PGP key is on my github profile readme.
Ideally using your gh handle and this repo as a password i.e. kilasuit/DocTypes
Don't know about PGP? there are other services that you can use like temp.pm & intime I will build & run my own
Want me to walk through PGP with you? let me know and
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Remove insecure guidance from placeholders and fix grammar.

Avoid suggesting using repo names or ad‑hoc passwords. Also fix capitalization and incomplete sentence endings.

Already covered with the body diff above; please adopt that wording.

🤖 Prompt for AI Agents
.github/ISSUE_TEMPLATE/presentationRequest.yml lines 13-29: the placeholder text
gives insecure guidance (suggesting repo names/ad-hoc passwords and PGP
instructions) and has grammar/capitalization and incomplete sentences; replace
the placeholder with the approved, concise wording from the provided body diff
that removes any insecure recommendations, fixes capitalization and punctuation,
and completes sentences; ensure validations.required remains true and the field
type/ID/labels stay intact while the description and placeholder present a safe,
clear request-for-contact message without instructing on password schemes or
insecure practices.

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.

Add CODEOWNERS File Add presentation Request issue template Process for joining as a maintainer
1 participant