Skip to content

[Repo] fix: Address Copilot feedback on community docs#22

Merged
finallyjay merged 1 commit intomainfrom
repo/fix-community-docs-feedback
Apr 8, 2026
Merged

[Repo] fix: Address Copilot feedback on community docs#22
finallyjay merged 1 commit intomainfrom
repo/fix-community-docs-feedback

Conversation

@finallyjay
Copy link
Copy Markdown
Owner

Summary

  • PR template: add markdownlint-disable MD041 to prevent lint failure on headless template
  • Code of Conduct: fix "contributes" → "contribute" grammar, replace public issue reporting with private advisory link, correct attribution from "adapted from v2.1" to "inspired by"
  • Security: remove mention of email contact (none provided), keep only the private advisory path
  • Support: add security disclosure bullet pointing to SECURITY.md, use reference-style links to stay under 80 chars

Addresses Copilot review comments from PRs #18, #19, #20, #21.

Test plan

  • Verify markdownlint passes
  • Verify private advisory link works in CODE_OF_CONDUCT.md and SECURITY.md

🤖 Generated with Claude Code

- PR template: disable MD041 for headless template
- Code of Conduct: fix grammar, use private advisory for
  reports, correct attribution
- Security: remove email mention, keep only advisory link
- Support: add security disclosure bullet, shorten URLs
  with reference links

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 8, 2026 15:56
@finallyjay finallyjay merged commit 2dd6c55 into main Apr 8, 2026
3 checks passed
@finallyjay finallyjay deleted the repo/fix-community-docs-feedback branch April 8, 2026 15:57
Copy link
Copy Markdown

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

Updates community documentation to address prior review feedback and keep Markdown linting green across the repo’s community health files.

Changes:

  • Add markdownlint-disable MD041 to the PR template to avoid first-line-heading lint failures.
  • Update SECURITY.md and SUPPORT.md to steer vulnerability reports to private GitHub Security Advisories.
  • Refine CODE_OF_CONDUCT.md wording and enforcement/reporting guidance, and adjust attribution language.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
SUPPORT.md Switches issue links to reference-style and adds a security disclosure pointer to SECURITY.md.
SECURITY.md Removes email-contact language and keeps a private advisory reporting path.
CODE_OF_CONDUCT.md Fixes grammar, changes reporting guidance to private advisory, and adjusts attribution phrasing.
.github/pull_request_template.md Disables MD041 to prevent markdownlint failures on a headless template.

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

Comment on lines +19 to +20
[bug]: https://github.com/finallyjay/selfhosted-docker-services/issues/new?template=bug-report.yml
[service]: https://github.com/finallyjay/selfhosted-docker-services/issues/new?template=new-service.yml
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

The reference-style link definitions include full GitHub URLs that exceed the repo’s MD013 line_length 80 setting, so markdownlint will still fail on these lines. Consider switching to shorter relative links (e.g., using ../../issues/new?... so GitHub resolves to the repo’s issue form) or otherwise ensuring the link target fits within 80 characters.

Copilot uses AI. Check for mistakes.
Comment on lines +8 to +9
**Do not open a public issue.** Instead, report it through
a [private security advisory](https://github.com/finallyjay/selfhosted-docker-services/security/advisories/new).
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

This inline link line exceeds the repo’s MD013 line_length 80 setting due to the full advisory URL, which will cause markdownlint to fail. Consider using a shorter relative link (e.g., ../../security/advisories/new) so the line stays within 80 characters.

Copilot uses AI. Check for mistakes.
Comment on lines +35 to +36
behavior may be reported through a
[private security advisory](https://github.com/finallyjay/selfhosted-docker-services/security/advisories/new).
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

This line exceeds the repo’s MD013 line_length 80 setting due to the full advisory URL, which will cause markdownlint to fail. Consider using a shorter relative link (e.g., ../../security/advisories/new) so the line stays within 80 characters.

Copilot uses AI. Check for mistakes.
Comment on lines 34 to +37
Instances of abusive, harassing, or otherwise unacceptable
behavior may be reported by opening an issue or contacting
the maintainer. All complaints will be reviewed and
investigated and will result in a response that is deemed
necessary and appropriate to the circumstances.
behavior may be reported through a
[private security advisory](https://github.com/finallyjay/selfhosted-docker-services/security/advisories/new).
All complaints will be reviewed and investigated and will
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

The Code of Conduct “Enforcement” section directs behavior/harassment reports to the GitHub Security Advisory flow, which is specifically designed for vulnerability disclosure. This may confuse reporters and mix conduct incidents into a security workflow; consider providing a dedicated private contact path for conduct reports (or explicitly stating that advisories are being used as the private reporting channel for CoC incidents).

Copilot uses AI. Check for mistakes.
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