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

Implement PR Issue Checker Workflow #968

Open
smog-root opened this issue Oct 20, 2024 · 4 comments
Open

Implement PR Issue Checker Workflow #968

smog-root opened this issue Oct 20, 2024 · 4 comments
Labels
question❓ Further information is requested

Comments

@smog-root
Copy link

Description: We need to create a GitHub Actions workflow that automates the validation of pull requests (PRs). This workflow will ensure that all PRs meet the following criteria before being merged:

PR Description Check: Every PR must have a description. If the description is missing, the PR should fail the check.

Issue Reference Check: The PR description must include an issue reference in the format Fixes #. If the PR is not addressing an existing issue, it should mention Fixes #NEW as a placeholder.

Acceptance Criteria:

  • A GitHub Action workflow is triggered on PR events (opened, edited).

The workflow checks the PR body for:

  • A non-empty description.
  • The presence of Fixes # or Fixes #NEW.

If the criteria are not met:

  • The workflow should fail and return clear error messages.

If the checks pass:

  • A confirmation message is outputted.

Expected Output:

  • Error message if the PR description is missing.
  • Error message if the issue reference is missing or incorrectly formatted.
  • Success message when all checks are satisfied.

Additional Notes:

  • This issue may serve as a foundation for more advanced PR validation (e.g., commit message format, label enforcement).
  • We can later extend this to check for specific branch naming conventions or enforce the addition of specific labels.

Note: i'm expecting a gssoc-ext with level3 (or) level2 and a hacktoberfest-accepted label!

@Avdhesh-Varshney

Copy link

Thank you for creating this issue! We'll look into it as soon as possible. Your contributions are highly appreciated! 😊

@Avdhesh-Varshney
Copy link
Owner

This workflow is not required.
Create a workflow which can check the guidelines in the pr to be followed.

  • Naming convention of the project added
  • ss to be present with the reqd naming convention and format
  • README file to be followed readme template
    If these not followed, mention the contributor

@Avdhesh-Varshney Avdhesh-Varshney added the question❓ Further information is requested label Oct 20, 2024
@smog-root
Copy link
Author

This workflow is not required.
Create a workflow which can check the guidelines in the pr to be followed.

  • Naming convention of the project added
  • ss to be present with the reqd naming convention and format
  • README file to be followed readme template
    If these not followed, mention the contributor

Can you give more context about it??

I'm not understanding!

@Avdhesh-Varshney
Copy link
Owner

Read it link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question❓ Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants