Repository navigation
docs: add an org-wide support guide - #52
Merged
Merged
Conversation
Add SUPPORT.md as a default community health file for every repository: where to ask (Q&A on the discussion board, Slack, issue forms, the security policy, email), what to do before asking and what to include, and what to expect (best-effort community support in English). List it in the README. Closes #44 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reviewer's GuideIntroduces an organization-wide SUPPORT.md with consistent guidance on where and how to request help, then exposes it through the README's community health file list and contribution guidance. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
uniqueg
marked this pull request as ready for review
November 1, 2026 03:59
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="SUPPORT.md" line_range="3-5" />
<code_context>
+# Support
+
+This guide applies to every repository of
+[ELIXIR On-Cloud](https://github.com/elixir-cloud-aai); repositories don't
+have their own `SUPPORT.md`.
+
+## Where to go
</code_context>
<issue_to_address>
**Private repositories lack default support**
When the organization has private repositories, gitHub does not apply organization default community health files to private repositories, so those repositories do not receive this guide unless they add their own support file or link to it.
Scope the claim to public repositories or make the guide available to private repositories through repository-specific support files or another shared mechanism.
</issue_to_address>
### Comment 2
<location path="SUPPORT.md" line_range="9-17" />
<code_context>
+
+## Where to go
+
+- Questions and help with using our projects: the [Q&A][q-a] category of
+ our [discussion board][discussions].
+- Chat with the community: our [Slack][slack].
+- Bugs and feature requests: the issue forms of the affected repository.
+- Vulnerabilities: report them privately, as described in the
+ [security policy](https://github.com/elixir-cloud-aai/.github/blob/main/SECURITY.md),
+ **never** in public issues or discussions.
+- Anything else: email
+ [cloud-service@elixir-europe.org](mailto:cloud-service@elixir-europe.org).
+
+## Before you ask
</code_context>
<issue_to_address>
**Email questions are discouraged**
When someone looking for help reads both organization-wide guides, readers are directed to Q&A or Slack for questions, while email is reserved for “Anything else”; `CONTRIBUTING.md` explicitly lists email as a way to ask questions. This gives users conflicting guidance and discourages an established support channel.
Include email as a question-support channel in `SUPPORT.md`, or update `CONTRIBUTING.md` to make the intended policy consistent.
</issue_to_address>Linked issues
#44 docs: add an org-wide support guide · 5 of 6 met
| # | Requirement | Status | Notes |
|---|---|---|---|
| 1 | Add an org-wide SUPPORT.md that applies to repositories without their own support guide. | ✅ Met | SUPPORT.md states that it applies across ELIXIR On-Cloud, and the README identifies it as an organization-wide community health file. |
| 2 | Direct users to the requested support channels. | ✅ Met | The guide covers Q&A, Slack, repository issue forms, private vulnerability reports, and email for anything else. |
| 3 | Use the same channels as the issue chooser's contact links (#43). | 🟡 Partly met | The guide lists the requested channels, but the existing issue chooser still directs questions to the deprecated contact page rather than linking to this guide. |
| 4 | Ask users to read the repository documentation and search issues and discussions first. | ✅ Met | Both steps are in the “Before you ask” section. |
| 5 | Ask users to include the repository and version, what they tried, and logs or errors without secrets. | ✅ Met | The “What to include” list covers these details. |
| 6 | Set expectations for best-effort community support, no guaranteed response times, and English. | ✅ Met | All three expectations appear in the “What to expect” section. |
Sourcery assessment
Approval pending. 2 findings to address first.
Blocking findings: SUPPORT.md:5, SUPPORT.md:17
Mention that questions that can't be asked in public go to the email address, consistent with the contributing guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an org-wide
SUPPORT.md(default community health file; repositoriesdon't override it), so GitHub shows support resources when someone opens an
issue:
affected repository, the security policy for vulnerabilities (never in
public), email for anything else.
discussions.
secrets.
times, in English.
The README lists the guide with the other community health files and in its
Contributing section. The channels match the issue chooser's contact links
(#43), which link this guide for email contact.
Closes #44
Light lane
Docs only (one new Markdown file, two README lines), no logic: no reviewer
subagents; I reviewed the diff myself.
How it was verified
pre-commit run --all-files(markdownlint, YAML and schema checks,gitleaks, shellcheck, actionlint): all passed.
pre-commit run --all-files --hook-stage manual gitleaks-all: passed.elixir-cloud-aai.github.ioand no deprecated names in thechanged files.
Declined review findings
.githubrepository to be public, and repositories do not add their own SUPPORT.md by design.Fixed: Sourcery, "email questions are discouraged" (f84fd54: email also for questions that can not be asked in public).
Open questions
None.
🤖 Generated with Claude Code