Skip to Content.
Sympa Menu

sphenix-software-l - [Sphenix-software-l] PR etiquette

sphenix-software-l AT lists.bnl.gov

Subject: sPHENIX discussion of software

List archive

Chronological Thread  
  • From: pinkenburg <pinkenburg AT bnl.gov>
  • To: "sphenix-software-l AT lists.bnl.gov" <sphenix-software-l AT lists.bnl.gov>
  • Subject: [Sphenix-software-l] PR etiquette
  • Date: Fri, 14 Jun 2024 08:27:55 -0400

Hi folks,

jenkins has a hard time keeping up with the number of PRs which are submitted. No problem with that but we have to make sure that this does not become a bottleneck for our development. Here are a few tips to alleviate the load:

This is the biggest one: Every push into a PR triggers a fresh jenkins run. I have seen users pushing changes into their PR after every commit on their local repo many times within minutes: Please commit everything first and then do a single push

Make sure your code (or PR change) actually compiles.

Often PRs fail when compiled with clang, get a head start on this by making sure your PR compiles with clang:
https://wiki.sphenix.bnl.gov/index.php?title=Tools#clang

run cppcheck yourself (this is really dirt simple):
https://wiki.sphenix.bnl.gov/index.php?title=Tools#Jenkins_Command_line

There will always be oops'es and "I forgot this" but we all benefit if we keep the load on jenkins as low as possible

Thanks,
Chris

--
*************************************************************

Christopher H. Pinkenburg ; pinkenburg AT bnl.gov
; http://www.phenix.bnl.gov/~pinkenbu

Brookhaven National Laboratory ; phone: (631) 344-5692
Physics Department Bldg 510 C ; fax: (631) 344-3253
Upton, NY 11973-5000

*************************************************************





Archive powered by MHonArc 2.6.24.

Top of Page