shyamtawli / devFind

devFind is an open source project that aims to create a platform for developers to showcase their skills and connect with potential collaborators, all in a user-friendly and searchable format.
https://dev-find.vercel.app/
MIT License
543 stars 582 forks source link

Auto Commenting when a PR is merged #1022

Open suhanipaliwal opened 3 months ago

suhanipaliwal commented 3 months ago

This feature aims to solve the problem of inconsistent and delayed communication following the merging of PRs. By automating the commenting process, it ensures that contributors receive timely feedback and acknowledgments. It also reduces the administrative burden on maintainers, allowing them to focus more on code reviews and other critical tasks.

Could you please assign me this issue under GSSOC'24.

github-actions[bot] commented 3 months ago

Welcome, @suhanipaliwal! Your issue is like a spark that ignites innovation. We're thrilled to dive into it and work together to find a solution.

Soon the maintainers/owner will review it and provide you with feedback/suggestions.

akbatra567 commented 3 months ago

@suhanipaliwal could you share some insights on how are you trying to achieve this also what do you mean why autocommenting after the PR is merged ? Like what all types of comments we need after the PR is merged ?

suhanipaliwal commented 3 months ago

I will adding a feature such that whenever a new pull request is merged, automatically a comment like this given below will be added on it.

Screenshot 2024-05-25 at 12 28 52 PM

To do this, I will be adding a YAML file in the .github directory to define this workflow of auto commenting on the trigger of a pull request being merged.

akbatra567 commented 3 months ago

@suhanipaliwal, Seems like a good idea, but I don't see this adding much value. Could you think of ways to improvise or add on to these details ?

Here are some of my suggestions for workflows:

  1. You can think of adding labels on PR, issue if not already added or update label like in-progress to done.
  2. You can implement https://github.com/marketplace/pull-request-size for PR sizing estimate, letting the reviewers get an idea of the PR size.
  3. You can look into some checkers for the PR so the reviewers do not need to point out basic, linting, naming, basic code improvements and just need to review the implementation logic. - maybe check something like eslint checker for PR reviews or other PR reviewer tools which can be incorporated in the github workflow.
akbatra567 commented 3 months ago

@suhanipaliwal assigned.