Before contributing AI slop PRs to this repo...

[gmlewis]

We have been getting a large influx of extremely low-quality PRs recently where the author does not even bother to review their own PR in the GitHub user interface before requesting it to be reviewed.

When doing this, you are creating a huge amount of frustration and wasting a great deal of everyone's time.

I think the Primeagen explains the situation quite well... please go watch this before posting your AI slop PR (to any repo):
https://www.youtube.com/watch?v=uZy1M_s-8zs

[alexandear]

@gmlewis, let's add AI slop info to the CONTRIBUTING file.

[gmlewis]

@gmlewis, let's add AI slop info to the CONTRIBUTING file.

Good idea, @alexandear.
Over the years I've read lots of blog posts about software engineering and there have been some great ones.
But I think there are a few fundamentals that remain top-of-mind that I feel are really important.
Here's a really short list that I can quickly think of:

• Always review your own PRs using the same user interface that your actual reviewers will be using with a critical eye, attempting to anticipate what your reviewers will call out, before asking anyone to review your PR. (I've violated this one myself so many times, I can't count... but whenever I violate this one, it invariably comes back to bite me.)
• Come up with a short and appropriate PR title
• Come up with a short, well-written, and appropriate PR description (we don't need hundreds of lines of text here - keep it short and to-the-point so a reviewer can quickly determine what the PR is all about)
• If a PR involves bug fixes, it should certainly include a unit test (or tests) that demonstrates the bug - without the PR changes, the new unit test would fail, but with the included PR changes, the new test(s) pass

I know there are more, but these I feel very strongly about.

Do you want to take a stab at updating the CONTRIBUTING.md file, @alexandear or should I?

[alexandear]

Do you want to take a stab at updating the CONTRIBUTING.md file, @alexandear or should I?

Sounds great, @gmlewis. You can update since you already have a clear idea of what to include.

[Not-Dhananjay-Mishra]

@gmlewis can we add one more line into it?

• If possible try to make smaller PRs it will be easy to review and try to avoids out of scope changes.

(Btw I m also guilty for larger PR sometimes 😅)

[gmlewis]

As I suspected, the "good first issue" label is turning out to be excellent clickbait for those who have not actually read the issue before wanting it to be assigned to them.

[Not-Dhananjay-Mishra]

As I suspected, the "good first issue" label is turning out to be excellent clickbait for those who have not actually read the issue before wanting it to be assigned to them.

Lol, I thought that it's for new contributor so they read this before contributing.