Skip to content
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

Improve change log #184

Merged
merged 1 commit into from
Jul 15, 2021
Merged

Improve change log #184

merged 1 commit into from
Jul 15, 2021

Conversation

oeway
Copy link
Contributor

@oeway oeway commented Jul 15, 2021

I try to separate changes that tends to break things from other changes.

@FynnBe @constantinpape Could you also take a look and see if I missed any change in the change log?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 15, 2021
Copy link
Member

@FynnBe FynnBe left a comment

Choose a reason for hiding this comment

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

good idea to separate 👍

- Only allow `license` identifier from the [SPDX license list](https://spdx.org/licenses/).
- Breaking changes
- The RDF file name in a package should be `rdf.yaml` for all the RDF (not `model.yaml`);
- Change `authors` and `packaged_by` fields from List[str] to List[Author] with Author consisting of a dictionary `{name: '<Full name>', affiliation: '<Affiliation>', orcid: 'optional orcid id'}`;
Copy link
Member

Choose a reason for hiding this comment

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

the general RDF still allows List[str]...

Copy link
Member

Choose a reason for hiding this comment

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

.. but we can focus on the model RDF here, doesn't hurt (I'm already happy with hits ;-))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a bit too complicated to clearly describe the distinction between general RDF and model RDF here, so I will leave it like this.

Copy link
Collaborator

@constantinpape constantinpape left a comment

Choose a reason for hiding this comment

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

LGTM, feel free to merge when @FynnBe is happy with this.

@oeway oeway merged commit 1891f83 into main Jul 15, 2021
@oeway oeway deleted the oeway-patch-1-1 branch July 15, 2021 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants