Skip to content

Commit 52225f1

Browse files
authored
chore: cleanup README (#4)
1 parent 90708f1 commit 52225f1

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
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.
44

5+
## Overview
6+
7+
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.
8+
59
## Features
610

711
The workflow can leave comments in these situations:
@@ -25,7 +29,7 @@ on:
2529

2630
jobs:
2731
pr-comments:
28-
uses: your-org/auto-comments/.github/workflows/pr-auto-comments.yml@main
32+
uses: RequestNetwork/auto-comments/.github/workflows/pr-auto-comments.yml@main
2933
with:
3034
org_name: "your-organization-name"
3135
# Optional: override the default comments
@@ -159,6 +163,16 @@ This workflow uses `pull_request_target` to ensure it has the necessary permissi
159163

160164
The workflow requires a token with `org:read` permission to check organization membership.
161165

166+
## Integration Testing
167+
168+
For integration testing purposes, we maintain a separate [auto-comments-test](https://github.com/RequestNetwork/auto-comments-test) repository. This repository contains workflows that:
169+
170+
1. Test actual PR events using the reusable workflow
171+
2. Allow manual simulation of different PR events
172+
3. Support testing different branches or versions of the workflow
173+
174+
If you're developing changes to this workflow, you can test them using the integration test repository before merging to the main branch.
175+
162176
## License
163177

164178
MIT

0 commit comments

Comments
 (0)