First time developer instructions

Prerequisites

To contribute to CMEW, you must:

• Have a GitHub account.
  • If you don't have a GitHub account, sign up at GitHub: Sign up to GitHub.
• Have write permissions to the CMEW repository.
  • If there is no pencil icon next to the rendered README file in the CMEW repository, you do not have write permissions. Contact Emma Hogan (@ehogan) to ask for write permissions.

First time developer instructions

• Set your username in git, commit e-mail address in git, and commit e-mail address in GitHub (your commit e-mail address may already be set; pay particular attention to step 6)
• Add a new SSH key to your GitHub account
• Clone the repository into the desired repository location:

  cd <desired_repository_location> 
  git clone [email protected]:MetOffice/CMEW.git 
  cd CMEW
  

• Activate the ESMValTool community environment, where <version> is the version of ESMValTool to use:

  module load scitools/community/esmvaltool/<version>
  

• Install the pre-commit git hook scripts:

  pre-commit install
  

  pre-commit: Install the git hook scripts provides more information. The pre-commit git hooks enables certain checks to automatically run every time a git commit command is performed.

Note

The pre-commit configuration file (GitHub: CMEW/.pre-commit-config.yaml) describes what hooks are installed.