search

DOI-USGS / ds-pipelines-targets-example-wqp

An example targets pipeline for pulling data from the Water Quality Portal (WQP)
Other
10 stars 14 forks source link

Add changelog #101

Closed lekoenig closed 1 year ago

lekoenig commented 1 year ago

This PR adds a project changelog to inform users of any edits to the template WQP pipeline after the initial release in September 2022. I don't intend to release formal versions of the code for now, so the changelog is organized in reverse chronological order by date.

Closes #100

padilla410 commented 1 year ago

Just to confirm, this looks like a manual process? Also, perhaps we should use releases after big edits. We are probably at 1.0 now.

lekoenig commented 1 year ago

Just to confirm, this looks like a manual process?

Yes, right now this is just a .md file in the repo that gets edited manually. I've experimented with automating it using a bash script but I decided it wasn't worth the complexity/effort given that this repo will hopefully not include new changes very often. My own two cents is that automation is most useful if you decided on a standard convention to use for commit messages at the start of the project.

Also, perhaps we should use releases after big edits. We are probably at 1.0 now.

I haven't used releases much in my own work and so I'd appreciate input on whether that makes sense for this repo. I've leaned toward not releasing formal versions because I hope that this repo won't be edited often. I've also wondered how releases affect the "use template" functionality, if at all.