Fast-forward cookiecutter - Githubissues

Ouranosinc / xscen

A climate change scenario-building analysis framework.

https://xscen.readthedocs.io/

Apache License 2.0

13 stars 2 forks source link

Fast-forward cookiecutter #407

Closed Zeitsperre closed 1 month ago

Zeitsperre commented 1 month ago

Pull Request Checklist:

[ ] This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #xyz
[x] (If applicable) Documentation has been added / updated (for bug fixes / features).
[ ] (If applicable) Tests have been added.
[x] This PR does not seem to break the templates.
[x] CHANGES.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

Updates the template to the latest commit
GitHub Workflows now point to commits rather than tags
Dependabot will now only update on a monthly schedule
Dependencies have been updated and synchronized
CODE_OF_CONDUCT.rst file adapted to Contributor Covenant v2.1

Does this PR introduce a breaking change?

Yes.

CHANGES.rst is now CHANGELOG.rst
The package now uses a src layout in lieu of a flat layout
Maintainer-specific directions are now found under releasing.rst

[!WARNING]
The changes to the package structure requires you to fully reinstall the library using pip install -e . This is almost like installing a brand new library, except it's virtually the same.

Other information:

https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/ https://keepachangelog.com/en/1.0.0/