search

bird-house / flyingpigeon

WPS processes for climate model data, indices and extreme events
http://flyingpigeon.readthedocs.io/en/latest/
Apache License 2.0
19 stars 15 forks source link

fix version 1.5.0 #300

Closed cehbrecht closed 4 years ago

cehbrecht commented 4 years ago

Overview

This PR updates to the version to 1.5.0

Related Issue / Discussion

299.

Additional Information

cehbrecht commented 4 years ago

@tlvu

Could we also add a releasing section in the README or a separate RELEASING file with steps how to do release.

Well, it is already in the dev guide: https://flyingpigeon.readthedocs.io/en/latest/dev_guide.html#bump-a-new-version

... but it is not so visible. What would you propose? We can open an issue for this on the cookiecutter ... a doc change should go into the template. There is also a contributing doc which we might use: https://github.com/bird-house/flyingpigeon/blob/master/.github/CONTRIBUTING.md

tlvu commented 4 years ago

@cehbrecht

Well, it is already in the dev guide: https://flyingpigeon.readthedocs.io/en/latest/dev_guide.html#bump-a-new-version

... but it is not so visible. What would you propose? We can open an issue for this on the cookiecutter ... a doc change should go into the template. There is also a contributing doc which we might use: https://github.com/bird-house/flyingpigeon/blob/master/.github/CONTRIBUTING.md

Oh I wasn't aware of that is already documented ! Clearly not visible. Usually the file that gets looked first is the README. So maybe add the reference to the README file?

Maybe add another line below "Documentation: https://flyingpigeon.readthedocs.io", something like "Development/Release Documentation: https://flyingpigeon.readthedocs.io/en/latest/dev_guide.html"

Or we might ask for more opinions on the gitter bird-house channel?

fmigneault commented 4 years ago

I agree with @tlvu here. Not visible in the readthedocs, README should state it or at the very least reference the readthedocs.