Skip to content

List data changes from cmu-delphi/covidcast-indicators#47 in a changelog #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 2, 2020

Conversation

krivard
Copy link
Contributor

@krivard krivard commented May 31, 2020

  • Creates a new page to hold the changelog
  • Prototypes a changelog format that balances completeness with concision
  • Adds references to changelog in each source section of _signals.md

We may want to pick a different anchor date, particularly for Quidel and Google Surveys.

Copy link
Contributor

@capnrefsmmat capnrefsmmat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks like a good structure -- just one suggestion to make heading linking easier so it's easy for us to update the changelog as needed

### `fb-survey`

<a name="fb-survey-v1.3"></a>
#### 3 June 2020: v1.3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory, this heading already has an anchor with id 3-june-2020-v1.3 or something like that.

I think, though, that it would be easier for each source section in covidcast_signals.md to link to the corresponding section in covidcast_changelog.md, rather than the section for the most recent update. So you'd only have to link to covidcast_changelog.md#fb-survey, where the user would immediately see the latest changes. That would make updates easier.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

…ion of changelog instead of the individual release.
@krivard krivard requested a review from capnrefsmmat June 2, 2020 19:06
@krivard krivard merged commit 9f21cb7 into cmu-delphi:master Jun 2, 2020
@krivard krivard deleted the fix/47 branch June 5, 2023 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants