-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update CONTRIBUTING guidelines to e.g. refer to new default branch (#674
) * Update CONTRIBUTING to refer to main not master branch * Update CONTRIBUTING to fix badly-formatted link * Update CONTRIBUTING to replace link with obsolete content
- Loading branch information
1 parent
f91fffa
commit 0f2bbea
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -80,14 +80,14 @@ $ make docs | |
$ git remote add upstream [email protected]: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 | ||
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:: | ||
|
||
|
@@ -102,15 +102,15 @@ $ make docs | |
$ python -m pip install -e . | ||
``` | ||
|
||
5. Install `pre-commit <https://pre-commit.com>`\_ hooks on the intake-esm repo:: | ||
5. Install [pre-commit](https://pre-commit.com) hooks on the intake-esm repo:: | ||
|
||
```bash | ||
$ pre-commit install | ||
``` | ||
|
||
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 | ||
|
@@ -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 | ||
``` |