From 966d42a796d1bfe1d3222ab107e210067f86d362 Mon Sep 17 00:00:00 2001 From: MantisClone Date: Fri, 21 Mar 2025 16:25:40 -0400 Subject: [PATCH] chore: cleanup README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f9244cd..ae16150 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ This reusable workflow adds automated comments on Pull Requests from external contributors. It identifies external contributors as users who are not members of your GitHub organization. +## Overview + +The `pr-auto-comments` workflow automatically posts customizable comments on Pull Requests submitted by external contributors (those outside your organization). It helps maintain consistent communication with contributors while reducing manual effort from maintainers. + ## Features The workflow can leave comments in these situations: @@ -25,7 +29,7 @@ on: jobs: pr-comments: - uses: your-org/auto-comments/.github/workflows/pr-auto-comments.yml@main + uses: RequestNetwork/auto-comments/.github/workflows/pr-auto-comments.yml@main with: org_name: "your-organization-name" # Optional: override the default comments @@ -159,6 +163,16 @@ This workflow uses `pull_request_target` to ensure it has the necessary permissi The workflow requires a token with `org:read` permission to check organization membership. +## Integration Testing + +For integration testing purposes, we maintain a separate [auto-comments-test](https://github.com/RequestNetwork/auto-comments-test) repository. This repository contains workflows that: + +1. Test actual PR events using the reusable workflow +2. Allow manual simulation of different PR events +3. Support testing different branches or versions of the workflow + +If you're developing changes to this workflow, you can test them using the integration test repository before merging to the main branch. + ## License MIT