Skip to content

docs: add community health files for A+ portfolio standards#8

Merged
donny-devops merged 1 commit into
mainfrom
enhancement/a-plus-upgrade
Jul 7, 2026
Merged

docs: add community health files for A+ portfolio standards#8
donny-devops merged 1 commit into
mainfrom
enhancement/a-plus-upgrade

Conversation

@donny-devops

Copy link
Copy Markdown
Owner

Changes

  • Add CONTRIBUTING.md with comprehensive contribution guidelines
  • Add SUPPORT.md with clear support channels and response times
  • Add CHANGELOG.md following Keep a Changelog format

Context

Part of portfolio A+ upgrade initiative to achieve top 1% GitHub profile standards.

Impact

  • ✅ Improves open-source readiness
  • ✅ Sets clear expectations for contributors
  • ✅ Provides structured support channels
  • ✅ Enables semantic versioning tracking

Docs-only addition, safe to merge.

- CONTRIBUTING.md: comprehensive contribution guidelines
- SUPPORT.md: clear support channels and response times
- CHANGELOG.md: semantic versioning change log template

Part of portfolio A+ upgrade initiative.
Copilot AI review requested due to automatic review settings July 7, 2026 17:09
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@sonarqubecloud

sonarqubecloud Bot commented Jul 7, 2026

Copy link
Copy Markdown

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review Summary

This PR successfully adds community health documentation (SUPPORT.md) as part of the A+ portfolio standards initiative. The file is well-structured with clear sections for different support channels, appropriate response time expectations, and proper references to existing repository files.

Verified:

  • ✅ All file references (SECURITY.md, CONTRIBUTING.md, README.md) point to valid files in the repository
  • ✅ Markdown syntax is correct
  • ✅ Content structure follows GitHub community standards
  • ✅ No security vulnerabilities or logic errors

Approval Status: Approved - no blocking issues identified. Safe to merge.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new SUPPORT.md file outlining how users can get help, report bugs, request features, and contact the maintainers. The review feedback suggests improving the robustness of the links to the repository's issues and discussions by using root-relative paths (e.g., /issues) instead of relative paths (e.g., ../../issues), which can break when viewed from nested branch structures.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread SUPPORT.md
Comment on lines +10 to +11
- **Issues**: Check [existing issues](../../issues) - your question may already be answered
- **Discussions**: Browse [GitHub Discussions](../../discussions) (if enabled) for Q&A and community support

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The relative links ../../issues and ../../discussions assume a specific directory depth when viewed on GitHub. If this file is viewed on a branch with a slash in its name (e.g., feature/add-support), the URL path has an extra segment, causing these links to resolve to broken URLs (e.g., .../blob/issues or .../blob/feature/issues).

To make these links robust across all branches, tags, and subdirectories, use root-relative paths starting with a /. GitHub automatically resolves links starting with / relative to the repository root.

Suggested change
- **Issues**: Check [existing issues](../../issues) - your question may already be answered
- **Discussions**: Browse [GitHub Discussions](../../discussions) (if enabled) for Q&A and community support
- **Issues**: Check [existing issues](/issues) - your question may already be answered
- **Discussions**: Browse [GitHub Discussions](/discussions) (if enabled) for Q&A and community support

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a community health SUPPORT.md file to document support channels, bug/feature request flow, security reporting guidance, and expected response times.

Changes:

  • Introduces SUPPORT.md with links to README, Issues, and (optionally) Discussions.
  • Documents expectations for bug reports, feature requests, and security vulnerability reporting.
  • Defines maintainer contact options and response-time SLAs.

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

Comment thread SUPPORT.md
Comment on lines +38 to +40
- **Quick questions**: Open an issue with the `question` label
- **General discussion**: Use GitHub Discussions (if enabled) or reach out to the maintainer
- **Community chat**: Check the README for any community Slack/Discord links
Comment thread SUPPORT.md
Comment on lines +51 to +53
- **Issues**: Reviewed within 3-5 business days
- **Pull requests**: Reviewed within 3-5 business days
- **Security reports**: Acknowledged within 24 hours
@donny-devops donny-devops merged commit 6c45106 into main Jul 7, 2026
11 checks passed
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