Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • For contributors on a new repo (even if they’ve committed in a different repo) their PR needs to have approval before checks are run (since the tests execute code).

  • Failed checks are authors responsibility except for needing to complete a CLA (pull in Feanil/Michelle)

    • If a CLA check doesn’t complete and shows as “pending” for more than a few minutes, it is likely stuck (it does not mean the check failed). A rebase should fix the problem.

    • If a PR is still in draft state, there is no need to ping authors about failing checks.

    • If a PR is not in draft state and the author asks for review, it usually makes sense to ask them to fix failing checks first.

      • However, if a PR introduces a large, impactful set of changes that requires input from more than one team (e.g. product and engineering), it can be a good idea to get the review process started early, regardless of failing checks. We want to avoid scenarios where authors spend days fixing small issues and getting the build green, only to be told by product and/or engineering that their changes are not going to be accepted or have already been introduced by another PR.

...

Open TODO items

  1. Update the bot to provide a welcome message saying test won’t run if you are a first time contributor

  2. Come up with a list of common issues when running checks - OSPR Project Managers can link to this doc when people have questions

    1. Sarina & Feanil will help create

    2. First part done - message about how to get CLA help is now messaged when the bot makes a comment on a PR without a CLA; see pull request for bot changes.

    3. Draft document up for the “doc for questions”. Not sure where to put it in the docs site, but comments can go here: https://docs.google.com/document/d/129cyHROlSXJRpt8O8TuqQTr6uVi-C7aY_6NgopFnq5k/edit?usp=sharing until I’m able to get a PR up in the proper place.

Finished TODO items

  1. Make a GitHub group such as @openedx/cla-problems in GitHub, whose members are all the OSPR Project Managers, so people have an easy way to ask questions

    1. Feanil will help create