Skip to content

Commit

Permalink
Add changelog (#626)
Browse files Browse the repository at this point in the history
* Add CHANGELOG.md from template

* Update guide and PR template with changelog instructions

* Update CHANGELOG.md

* Update CHANGELOG.md

Add link to PR
  • Loading branch information
peanutfun authored Jan 27, 2023
1 parent 27d5a9d commit fe2502b
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This PR fixes #
- [ ] [Tests][testing] updated
- [ ] [Tests][testing] passing
- [ ] No new [linter issues][linter]
- [ ] [Changelog](https://github.com/CLIMADA-project/climada_python/blob/main/CHANGELOG.md) updated

### PR Reviewer Checklist

Expand Down
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Changelog

## Unreleased

Release date: YYYY-MM-DD

Code freeze date: YYYY-MM-DD

### Description

### Dependency Changes

### Added

- Changelog based on the CLIMADA release overview and https://keepachangelog.com template [#626](https://github.com/CLIMADA-project/climada_python/pull/626)

### Changed

### Fixed

### Deprecated

### Removed
16 changes: 12 additions & 4 deletions doc/guide/Guide_Git_Development.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {
"slideshow": {
Expand All @@ -472,6 +473,7 @@
"- Tutorial (if a complete new feature)\n",
"- Updated dependencies (if need be)\n",
"- Added your name to the AUTHORS file\n",
"- Added an entry to the ``CHANGELOG.md`` file. See https://keepachangelog.com for information on how this shoud look like.\n",
"- (Advanced, optional) interactively rebase/squash recent commits that _aren't yet on GitHub_.\n"
]
},
Expand Down Expand Up @@ -530,6 +532,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {
"slideshow": {
Expand Down Expand Up @@ -725,7 +728,7 @@
"- Don't commit anything containing passwords or authentication credentials or tokens. (These are annoying to remove from the Git history.) Contact the team if you need to manage authorisations within the code.\n",
"- Don't commit anything that can be created by the CLIMADA code itself\n",
"\n",
"If files like this are going to be present for other users as well, add them to the repository's `.gitignore`.",
"If files like this are going to be present for other users as well, add them to the repository's `.gitignore`.\n",
"\n",
"#### Jupyter Notebook metadata\n",
"\n",
Expand All @@ -735,7 +738,7 @@
"\n",
"Several code editors use plugins to render Jupyter Notebooks. Here we collect the instructions to inspect Jupyter Notebooks as plain text when using them:\n",
"- **VSCode**: Open the Jupyter Notebook. Then open the internal command prompt (`Ctrl` + `Shift` + `P` or `Cmd` + `Shift` + `P` on macOS) and type/select 'View: Reopen Editor with Text Editor'"
]
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -880,7 +883,7 @@
"metadata": {
"celltoolbar": "Slideshow",
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
Expand All @@ -894,7 +897,12 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.12"
"version": "3.8.15 | packaged by conda-forge | (default, Nov 22 2022, 08:49:06) \n[Clang 14.0.6 ]"
},
"vscode": {
"interpreter": {
"hash": "fe76ddefd4ac3b756bca82b2809865e7c67c346a46477cb9eec4ead581742ab6"
}
}
},
"nbformat": 4,
Expand Down

0 comments on commit fe2502b

Please sign in to comment.