Add a PR checklist item for "I have read the contributing guide..." as a catch-all
dbeatty10 opened this issue · 0 comments
dbeatty10 commented
Describe the "under the hood" change
Our PR template is pretty long, which makes it onerous to use. These items are already covered in our contribution guidelines in their own section:
![image](https://private-user-images.githubusercontent.com/44704949/336606938-0b9232c1-efca-4146-a5be-200a0a6d95a9.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjIxMjg3NDQsIm5iZiI6MTcyMjEyODQ0NCwicGF0aCI6Ii80NDcwNDk0OS8zMzY2MDY5MzgtMGI5MjMyYzEtZWZjYS00MTQ2LWE1YmUtMjAwYTBhNmQ5NWE5LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzI4VDAxMDA0NFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQxZDQzYjJiMTZlYzI2Y2RlNDJjNWI4ZjlmOGNhZGVmNWVkZDFkZDliOWRjZmYzNTFkNmQ5Y2IxMTg1NjQxY2EmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.mMA2WldKn_1eRDe3deEtWzuCPFcCQnuNZiU8F7Sjq8Y)
So we should remove these (4) checklist items for a (1) checklist item that says:
- I have read the contributing guide and understand what's expected of me
Then the PR reviewer can just link to that section of the contribution guide as-needed.
Who will this benefit?
This will reduce the length of the PR checklist, which will make it easier to complete (in alignment with the suggestions within the Checklist Manifesto).
This will also more closely align the PR template within dbt-utils with the PR templates of dbt-core, dbt-adapters, etc.