Skip to content

Revise contributors section in README.md #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
JorchCortez merged 1 commit into from
Nov 10, 2025
Merged

Revise contributors section in README.md #67

JorchCortez merged 1 commit into from
Nov 10, 2025

Conversation

@JorchCortez
Copy link
Contributor

@JorchCortez JorchCortez commented Nov 10, 2025

Updated contributors section formatting and removed old content.

New Feature: [Feature Title]

Description

Provide a brief summary of the new feature added to an existing script. Highlight what enhancement it brings or the new functionality introduced.

Related Issues

  • Link any issues related to this feature (e.g., Fixes #123).

Script Details

  • Script Name: [Name of the existing script]
  • Purpose of Update: Describe why this update was necessary.
  • New Behavior: Explain the new functionality added.

Changes Made

  • List the key modifications or additions to the script.

Features

This PR closes NONE

Checklist

  • Feature has been tested locally with all relevant use cases.
  • Documentation has been updated (if necessary).
  • PR does not match another non-stale PR currently opened
  • PR name matches the format [ feature ]: Feature Name (versions separated by comma). More details here
  • PR's base is the develop branch.
  • Your Feature matches the standards laid out here

Additional Notes

Add any extra details or comments for reviewers.

@JorchCortez
Revise contributors section in README.md
195d850 
Updated contributors section formatting and removed old content.

Signed-off-by: Jorge C. <jacortez_94@hotmail.com>
Copilot AI review requested due to automatic review settings November 10, 2025 21:32
@JorchCortez JorchCortez merged commit 8277017 into main Nov 10, 2025
2 checks passed
@JorchCortez JorchCortez deleted the JorchCortez-patch-5 branch November 10, 2025 21:33
Copilot AI reviewed Nov 10, 2025
View reviewed changes
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 revises the Contributors section in README.md by converting it from HTML to Markdown formatting and updating the auto-generated contributor placeholder tags from contributors to collaborators,contributors. The explanatory text about automatic updates has also been removed to streamline the section.

Key changes:

  • Converted heading from HTML (<h2 id="contributors">) to Markdown (##)
  • Updated placeholder tags to include both collaborators and contributors
  • Removed descriptive paragraph explaining the auto-update behavior

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

README.md

<!-- readme: contributors -start -->
<!-- readme: contributors -end -->
## Contributors
Copy link

Copilot AI Nov 10, 2025

Choose a reason for hiding this comment

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

The Contributors heading uses Markdown syntax (##) while all other sections in the README use HTML syntax (<h2 id=\"...\">). This creates formatting inconsistency. Additionally, the missing id attribute means the Contributors section cannot be linked from a table of contents. Consider changing to <h2 id=\"contributors\">Contributors</h2> to match the pattern used by other sections like 'Stale Pull Requests', 'Contributing', 'Discord community', etc.

Suggested change
## Contributors
<h2 id="contributors">Contributors</h2>

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@JorchCortez