Skip to content

chore: cleanup README #4

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
merged 1 commit into from
Mar 21, 2025
Merged

chore: cleanup README #4

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
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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