From 530feee6c4394e2110b9fc88da59e0039cd39cca Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Tue, 9 Jul 2024 17:40:45 +0100 Subject: [PATCH 1/3] Update CONTRIBUTING to refer to main not master branch --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12734ff7..61e9b595 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,10 +80,10 @@ $ make docs $ git remote add upstream git@github.com:intake/intake-esm.git ``` - now, to fix a bug or add feature create your own branch off "master": + now, to fix a bug or add feature create your own branch off "main": ```bash - $ git checkout -b your-bugfix-feature-branch-name master + $ git checkout -b your-bugfix-feature-branch-name main ``` If you need some help with Git, follow this quick start @@ -142,5 +142,5 @@ $ make docs compare: your-branch-name base-fork: intake/intake-esm - base: master # if it's a bugfix or feature + base: main # if it's a bugfix or feature ``` From 025537ed0e495f3e4f0c28ce85ccbaa452b3377e Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Tue, 9 Jul 2024 17:45:56 +0100 Subject: [PATCH 2/3] Update CONTRIBUTING to fix badly-formatted link --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61e9b595..f6c7465b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,7 +102,7 @@ $ make docs $ python -m pip install -e . ``` -5. Install `pre-commit `\_ hooks on the intake-esm repo:: +5. Install [pre-commit](https://pre-commit.com) hooks on the intake-esm repo:: ```bash $ pre-commit install @@ -110,7 +110,7 @@ $ make docs Afterwards `pre-commit` will run whenever you commit. - [pre-commit](https://pre-commit.com) is a framework for managing and maintaining multi-language pre-commit hooks to ensure code-style and code formatting is consistent. + `pre-commit` is a framework for managing and maintaining multi-language pre-commit hooks to ensure code-style and code formatting is consistent. Now you have an environment called `intake-esm-dev` that you can work in. You’ll need to make sure to activate that environment next time you want From 3e2eb32614104e3cffdf9541cbaa4064076871c9 Mon Sep 17 00:00:00 2001 From: "Sadie L. Bartholomew" Date: Tue, 9 Jul 2024 17:47:08 +0100 Subject: [PATCH 3/3] Update CONTRIBUTING to replace link with obsolete content --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6c7465b..6b44198a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,7 +87,7 @@ $ make docs ``` If you need some help with Git, follow this quick start - guide: https://git.wiki.kernel.org/index.php/QuickStart + guide: https://docs.github.com/en/get-started/getting-started-with-git 3. Install dependencies into a new conda environment::