Versions Compared

Key

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

...

Convention:  E3SM branch names must on E3SM-Project/E3SM must have the form:

<Github username>/<source code area or component>/<feature-description>

Branches on a developer's personal E3SM fork do not need to start with <Github username> because this is clear from the fork name:

<source code area or component>/<feature-description>
  • Use lower-case for everything.  Even your username.
  • Use hyphens instead of underscores.
  • one name for the github username.  
    • This is the person in charge of the branch and not necessarily the only person working on it.
    • The E3SM IG needs one person to act as point-of-contact to answer questions about the branch and take requests for merging.
    • This is why github usernames should be close to the your real name.
    • Only needed for branches directly on E3SM-Project/E3SM 
  • Group leads may make additional conventions for <source code area or component> and <feature-description>.

...