Skip to content

docs: use the org-wide community files - #488

Open
uniqueg wants to merge 1 commit into
devfrom
docs/org-community-files
Open

uniqueg wants to merge 1 commit into
devfrom
docs/org-community-files

Conversation

@uniqueg

@uniqueg uniqueg commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Summary

Use the organisation's default community health files from
elixir-cloud-aai/.github
instead of repository copies.

  • Removed CODE_OF_CONDUCT.md: a generic Contributor Covenant 2.1 whose
    contact was still [INSERT CONTACT METHOD]; the org default is version 3.0
    with a contact address.
  • Removed PULL_REQUEST_TEMPLATE.md and
    .github/ISSUE_TEMPLATE/general-purpose.md (generic templates); with the
    issue template folder gone, the org's issue forms and config.yml apply.
  • Kept CONTRIBUTING.md: it only describes what is specific to this
    repository (pull request checks and the release steps from ci: single CI gate and contribution docs #474), so it
    deliberately stays the repository's contributing guide. Its pull request
    step now says Closes #123, as in the org pull request template.
  • Pointed the code of conduct links in README.md and CONTRIBUTING.md to
    the org file, and reworded the README's reporting sentence accordingly.
  • Left the CODE_OF_CONDUCT.md entries in .prettierignore and the
    .eslintignore files as they are (harmless, and the package generator
    template has them too).

Closes #487

Verification

  • No links to the removed files remain (grep).
  • The docs site (apps/documentation) does not include any of the changed
    files, so I did not build it locally; CI lints, builds and tests.
  • CI: all checks pass, including the Read the Docs build (one Read the Docs
    build was cancelled and one Test (Node 24) job hung while installing
    Playwright dependencies; both passed when re-run).

Light lane: the PR only removes files and fixes links and text in docs, so it
skips the reviewer subagents; I reviewed the diff myself.

Declined review findings

None

Open questions

None

🤖 Generated with Claude Code

Summary by Sourcery

Use the organisation-wide community health files and update repository documentation to reference them.

Enhancements:

  • Adopt the organisation-wide community health files by removing repository-specific code of conduct and issue and pull request templates.
  • Retain repository-specific contribution guidance while aligning its code of conduct link and pull request wording with the organisation defaults.
  • Update README code of conduct references and reporting guidance to point to the organisation policy.

Documentation:

  • Update repository documentation to reference the organisation's shared code of conduct and community reporting process.

Remove CODE_OF_CONDUCT.md, PULL_REQUEST_TEMPLATE.md and the general
purpose issue template, so that GitHub uses the defaults of
elixir-cloud-aai/.github, and point the code of conduct links to the
org file. Keep CONTRIBUTING.md with the repository's PR and release
steps.

Closes #487

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This documentation-only PR removes duplicated community health files so GitHub can use the organisation defaults, while retaining repository-specific contribution instructions and updating all code-of-conduct links and wording accordingly.

File-Level Changes

Change Details Files
Replaced repository-local community health files with the organisation-wide defaults.
  • Deleted the repository code of conduct, pull request template, and generic issue template.
  • Updated the remaining contributing guide to link to the organisation code of conduct and match the organisation’s pull request wording.
  • Removed the repository issue-template directory so organisation issue forms and configuration can apply.
CODE_OF_CONDUCT.md
PULL_REQUEST_TEMPLATE.md
.github/ISSUE_TEMPLATE/general-purpose.md
CONTRIBUTING.md
Updated README code-of-conduct guidance to reference the organisation-managed policy.
  • Reworded reporting guidance to direct contributors to the moderators and contact process in the organisation policy.
  • Changed the reference target to the organisation .github repository.
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#487 Remove the repository-specific code of conduct, pull request template, and general-purpose issue template so the organization-wide community files apply. ✅
#487 Keep the repository-specific contributing guide, update its code-of-conduct link to the organization file, and align its pull-request instructions with the organization template. ✅
#487 Update the README’s code-of-conduct link and related wording to refer to the organization-wide policy. ✅

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@uniqueg uniqueg closed this Oct 27, 2026
@uniqueg uniqueg reopened this Oct 27, 2026
@uniqueg
uniqueg marked this pull request as ready for review October 27, 2026 18:44
@uniqueg
uniqueg requested a review from anuragxxd as a code owner October 27, 2026 18:44

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

This branch has not been deployed

No deployments
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.

docs: use the org-wide community files

1 participant