Skip to content

Commit

Permalink
populate the changelog (#99)
Browse files Browse the repository at this point in the history
* fill in the changelog

* bug fixes

* pull request changelog

* use the proper role
  • Loading branch information
keewis authored Nov 22, 2024
1 parent 353130d commit 3e3aa3c
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- [ ] closes #xxxx
- [ ] Tests added
- [ ] User visible changes (including notable bug fixes) are documented in `changelog.md`
- [ ] New functions/methods are listed in `api.rst`
30 changes: 30 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,36 @@

All notable changes to this project will be documented in this file.

## 0.1.0 (_unreleased_)

### Enhancements

- derive cell boundaries ({pull}`30`)
- add grid objects ({pull}`39`, {pull}`57`)
- decoder function ({pull}`47`, {pull}`48`)
- rename the primary grid parameter to `level` ({pull}`65`)
- interactive plotting with `lonboard` ({pull}`67`)
- expose example datasets through `xdggs.tutorial` ({pull}`84`)

### Bug fixes

- fix the cell centers computation ({pull}`61`)
- work around blocked HTTP requests from RTD to github ({pull}`93`)

### Documentation

- create a readme ({pull}`70`)
- create the documentation ({pull}`79`, {pull}`80`, {pull}`81`, {pull}`89`)
- fix headings in tutorials ({pull}`90`)
- rewrite the readme ({pull}`97`)

### Internal changes

- replace `h3` with `h3ronpy` ({pull}`28`)
- setup CI ({pull}`31`)
- tests for the healpix index ({pull}`36`)
- testing utils for exception groups ({pull}`55`)

## 0.0.1 (2023-11-28)

Preliminary version of `xdggs` python package.

0 comments on commit 3e3aa3c

Please sign in to comment.