Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING guidelines to e.g. refer to new default branch #674

Merged
merged 3 commits into from
Jul 26, 2024
Merged

Update CONTRIBUTING guidelines to e.g. refer to new default branch #674

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
530feee
Update CONTRIBUTING to refer to main not master branch
sadielbartholomew Jul 9, 2024
025537e
Update CONTRIBUTING to fix badly-formatted link
sadielbartholomew Jul 9, 2024
3e2eb32
Update CONTRIBUTING to replace link with obsolete content
sadielbartholomew Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand All @@ -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
Expand Down Expand Up @@ -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
```