Skip to content

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

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

Merged
finallyjay merged 1 commit into from
Apr 8, 2026
+22 −17
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- markdownlint-disable MD041 -->

## Summary
<!-- What does this PR do and why? -->

Expand Down
16 changes: 8 additions & 8 deletions CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ orientation.

## Our Standards

Examples of behavior that contributes to a positive
Examples of behavior that contribute to a positive
environment:

- Using welcoming and inclusive language
Expand All @@ -32,13 +32,13 @@ Examples of unacceptable behavior:
## Enforcement

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).
Comment on lines +35 to +36
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.
All complaints will be reviewed and investigated and will
Comment on lines 34 to +37
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.
result in a response that is deemed necessary and
appropriate to the circumstances.

## Attribution

This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org),
version 2.1.
This Code of Conduct is inspired by the
[Contributor Covenant](https://www.contributor-covenant.org).
5 changes: 2 additions & 3 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
If you discover a security vulnerability in this project,
please report it responsibly.

**Do not open a public issue.** Instead, contact the
maintainer directly by email or through a
[private security advisory](https://github.com/finallyjay/selfhosted-docker-services/security/advisories/new).
**Do not open a public issue.** Instead, report it through
a [private security advisory](https://github.com/finallyjay/selfhosted-docker-services/security/advisories/new).
Comment on lines +8 to +9
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.

Please include:

Expand Down
16 changes: 10 additions & 6 deletions SUPPORT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@ following resources:
- **Service-specific questions:** Check the `README.md`
inside the service directory for setup details and
environment variables.
- **Bug reports:** Open an
[issue](https://github.com/finallyjay/selfhosted-docker-services/issues/new?template=bug-report.yml)
using the bug report template.
- **New service requests:** Open an
[issue](https://github.com/finallyjay/selfhosted-docker-services/issues/new?template=new-service.yml)
using the new service template.
- **Bug reports:** [Open an issue][bug] using the bug
report template.
- **New service requests:** [Open an issue][service] using
the new service template.
- **Security vulnerabilities:** Do not open a public issue.
See [SECURITY.md](SECURITY.md) for how to report
privately.

[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
Comment on lines +19 to +20
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.

## Out of Scope

Expand Down
Loading