Skip to content
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.

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

Create auto_comment.yml #92

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions .github/workflows/auto_comment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Auto Comment

on:
issues:
types: [opened, closed, assigned, unassigned]
pull_request:
types: [opened]

jobs:
auto-comment:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v2

- name: Auto Comment
uses: wow-actions/auto-comment@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
issue-body: |
Thank you, @${{ github.event.sender.login }}, for opening this issue! Could you please provide additional context or details about the problem you're facing?
pr-body: |
Hi, @${{ github.event.sender.login }}! We appreciate your pull request. Before we proceed, please make sure to review and follow our contributing guidelines.
closed-issue-body: |
Thank you, @${{ github.event.sender.login }}, for your contribution! We appreciate your effort. If you have any further questions or would like to contribute more, feel free to reach out.
assigned-issue-body: |
Hi, @${{ github.event.issue.assignee.login }}! This issue has been assigned to you. We look forward to your work on it.
unassigned-issue-body: |
Hi, @${{ github.event.issue.assignee.login }}! This issue has been unassigned from you. If you're unavailable, please let us know, and we can reassign it to someone else.

34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,40 @@ This repository hosts scripts written in bash and python to automate common Git/
</div>
<br>

# My Awesome Project

Welcome to My Awesome Project! This project aims to improve collaboration and communication among contributors.

## Auto-Comment Feature

The auto-comment feature has been implemented to enhance collaboration and streamline communication within the project. It automatically generates comments in response to specific events, providing acknowledgements, instructions, and reminders. Here's how the auto-comment feature works:

- When an issue is opened, an auto-comment is posted to greet the author and request additional context.
- When a pull request is opened, an auto-comment expresses gratitude and reminds the author to follow the project's contributing guidelines.
- When an issue is closed, an auto-comment thanks the author for their contribution and encourages further engagement.
- When an issue is assigned, an auto-comment notifies the assignee and encourages them to start working on it.
- When an issue is unassigned, an auto-comment notifies the assignee about the change and suggests reassignment if they are offline.

These auto-comments aim to improve communication, provide clear instructions, and reduce manual effort by automating comment generation.

## Getting Started

To get started with My Awesome Project, follow these steps:

1. Clone the repository: `git clone https://github.com/your-username/my-awesome-project.git`
2. Install the dependencies: `npm install`
3. Run the project: `npm start`

Feel free to explore the code, contribute, and engage with the community!

## New Features

- Auto-comment feature implemented: This feature automatically generates comments in response to specific events, improving collaboration and communication within the project.

We hope you find the auto-comment feature helpful and enjoy contributing to My Awesome Project. If you have any questions or need assistance, don't hesitate to reach out to us.

Happy coding!

## Table of Content
- [Tech](#tech)
- [Installation](#installation)
Expand Down