Add workflow to comment on new PRs #5544
Conversation
Signed-off-by: svrnm <[email protected]>
| We will run some checks on your PR. If they fail, take a look in to our [guide on pr-checks](https://opentelemetry.io/docs/contributing/pr-checks/). | ||
| Most issues can be resolved by running \`npm run fix:all\` locally and pushing the changes. | ||
| But please note that it is not your responsibility to fix all the issues. We will help you with that. |
There was a problem hiding this comment.
| We will run some checks on your PR. If they fail, take a look in to our [guide on pr-checks](https://opentelemetry.io/docs/contributing/pr-checks/). | |
| Most issues can be resolved by running \`npm run fix:all\` locally and pushing the changes. | |
| But please note that it is not your responsibility to fix all the issues. We will help you with that. | |
| We run checks on all PRs. If a check fails on your PR, look for the fix in our [guide](https://opentelemetry.io/docs/contributing/pr-checks/). | |
| Most issues can be resolved by running \`npm run fix:all\` locally and pushing the changes. | |
| But please note that it is not your responsibility to fix these issues. We will help you. |
| repo: context.repo.repo, | ||
| body: `Hello 👋! Thanks for opening a pull request. | ||
|
|
||
| Please make sure to follow the [contribution guidelines](https://opentelemetry.io/docs/contributing/). |
There was a problem hiding this comment.
| Please make sure to follow the [contribution guidelines](https://opentelemetry.io/docs/contributing/). | |
| Make sure that you are following our [contribution guidelines](https://opentelemetry.io/docs/contributing/). |
|
|
||
| Please make sure to follow the [contribution guidelines](https://opentelemetry.io/docs/contributing/). | ||
|
|
||
| We will run some checks on your PR. If they fail, take a look in to our [guide on pr-checks](https://opentelemetry.io/docs/contributing/pr-checks/). |
There was a problem hiding this comment.
| We will run some checks on your PR. If they fail, take a look in to our [guide on pr-checks](https://opentelemetry.io/docs/contributing/pr-checks/). | |
| We run some checks on your PR. For guidance on what to do when checks fail, see [PR checks](https://opentelemetry.io/docs/contributing/pr-checks/). |
|
|
||
| We will run some checks on your PR. If they fail, take a look in to our [guide on pr-checks](https://opentelemetry.io/docs/contributing/pr-checks/). | ||
| Most issues can be resolved by running \`npm run fix:all\` locally and pushing the changes. | ||
| But please note that it is not your responsibility to fix all the issues. We will help you with that. |
There was a problem hiding this comment.
| But please note that it is not your responsibility to fix all the issues. We will help you with that. | |
| We maintainers can sometimes help you resolve issues with your PR, but fixing them is up to you. |
There was a problem hiding this comment.
I phrased it that way because depending on the issue I rather fix it myself vs leaving it to an (unexperienced) contributor. It can be very frustrating for them to get the checks all satisfied. They create a lot of notifications for us and also a lot of CI check runs that clog the github workers.
A different wording would be:
Do not worry about the status of the CI checks after submitting your PR. We will provide you with guidance, when and how to address them.
Yes, what I want to do is double checking if commenting if and only if at least one check fails would be the better choice, or even something like "hey this and that checked failed, you can run this and that command to fix it", but depending on the complexity I would start with this one and evolve from there. Thanks for the initial feedback |
|
I will revisit this once again, I have a few more ideas to make this less spammy. Let's finish #5545 first, it's the best starting point 👍 |
this is a follow up to #5489 and a different approach to address the issue: when contributors raise a PR with our project they were often struggle with our CI checks, since there are many of them and they are often not aware of the capabilities we have to auto-fix the most common issues. At the same time we want to let them know that they do not have to worry about failed CI checks, since we can help them with addressing them (often I actually prefer fixing them myself before merging a PR).
Currently a PR submitter will not get this information if they do not read deep into our contribution guidelines. So instead of leaving them lost when they submit a PR, I suggest 2 solutions (we can have both):
Personally I would prefer having both options, but the downside of (1) is that it will comment on every new PR. There are ways to reduce that to first time contributors or we could only comment if CI checks fail, but I wanted to put this out for discussion first.
Here is a comment how it would look like:
svrnm#189 (comment)