Getting started as EasyBuild maintainer - easybuilders/easybuild GitHub Wiki

Note: this page is a work-in-progress, comments/suggestions are welcome!

Pro tip: you can edit this page as an EasyBuild maintainer, so feel free to add things that are missing or need further clarification.

Attention points

• always be welcoming & friendly, especially to newcomers
• never merge your own PRs
  • you usually can't anyway, due to branch restrictions set up in GitHub
• take into account the requirements for pull requests
• if you're not sure about something, ask in #maintainers on Slack
  • see also https://easybuild.readthedocs.io/en/latest/Maintainers.html
• "With great power comes great responsibility. And free beer every now and then."

Workflow for reviewing/merging contributions

• use eb --review-pr to review easyconfig PRs (+ visual review in PR)
  • see also https://easybuild.readthedocs.io/en/latest/Integration_with_GitHub.html#reviewing-easyconfig-pull-requests-review-pr
• use eb --merge-pr to merge PRs
  • see https://easybuild.readthedocs.io/en/latest/Integration_with_GitHub.html#merging-easyconfig-pull-requests-merge-pr}

Policies

• it's up to you:
  • how much time you spend on EasyBuild maintenance tasks
  • when you process incoming contributions
  • whether/when you join to Maintainer-of-the-Week (MotW) rotating role
  • which PRs you focus on

Other

• make sure labels and milestones are set correctly
• consider if easyconfigs can be moved to lower subtoolchains
• consider using the shared testing environment provided by CSCS
• use https://octobox.io to manage GitHub notifications