p5.js-web-editor icon indicating copy to clipboard operation
p5.js-web-editor copied to clipboard

Text cut off in contributor docs under "Preparing a pull request"

Open team-epk opened this issue 4 months ago • 1 comments

p5.js version

1.11.8

What is your operating system?

Mac OS

Web browser and version

Firefox 141.0.3 (aarch64)

Actual Behavior

In the contributor docs' Preparing a pull request page, the section titled "Pull Request Templates" turns into a bit of a cliffhanger:

Pull Request Templates Once you've opened your pull request, please ensure that you follow the guidelines and

What happens after the "and?" (I pretended the suspense wasn't killing me and managed to submit my pull request without knowing, though it made me a little more nervous than I already was, it being my first pull request and all!)

Expected Behavior

I was hoping to learn what the additional step(s) to ensure beyond following the guidelines was.

Steps to reproduce

Go to Preparing a pull request page, scroll to the pull request templates section, and read the steps.

team-epk avatar Aug 21 '25 15:08 team-epk

Thanks so much for catching this @team-epk! I realized I completely forgot to fill out the rest of that section 😂

It was mostly supposed to provide an explanation of the verification steps in our pull request templates that a contributor might see when they open a pull request—so it would explain what each of these mean:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #issue-number

raclim avatar Aug 26 '25 19:08 raclim