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

chore: Update pr.yaml to show actual condition so easier to follow #429

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

monilpat
Copy link
Contributor


Relates to:

No specific issue linked. Improving PR error messaging.

Risks

Low: This change only affects error messages shown during PR validation.

Background

What does this PR do?

This PR updates the pr.yaml configuration file to include explicit error messages for pull request validation. The messages provide clear guidance on expected fields and values.

What kind of change is this?

  • Improvement (miscellaneous changes to existing features).

Why are we doing this? Any context or related work?

To enhance the contributor experience by providing clearer error messages, reducing confusion, and speeding up corrections.

Documentation changes needed?

My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

Review the updated pr.yaml file. Focus on the checks section where the error messages have been updated.

Detailed testing steps

  1. Create a pull request with missing or incorrect fields.
  2. Confirm that the error messages specify the required corrections.
  3. Verify that all expected options (e.g., PR types) are listed clearly in the error message.

@jkbrooks jkbrooks merged commit 02effe0 into ai16z:main Nov 20, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants