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.

Sign up for GitHub

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

Jump to bottom

Assorted changes: audience, contributing guidelines, remove .zenodo.json #368

Merged
merged 4 commits into from
Jan 10, 2024
Merged

Assorted changes: audience, contributing guidelines, remove .zenodo.json #368

merged 4 commits into from
Jan 10, 2024

Conversation

egpbos
Copy link
Member

@egpbos egpbos commented Dec 22, 2023

Description

This PR contains four separately reviewable commits to fix some long-standing issues and do some general maintenance:

  • It adds Science/Research as intended audience (fixes which Intended Audience under classifiers in setup.py? #111).
  • It harmonizes the CONTRIBUTING.md files in the template and the generated project (fixes nothing, except my sensibilities).
  • Removes .zenodo.json from the template, since it is outdated, and also updates the generated project to remove references to it (the file itself was not there, but the "next step" issue and the cffconvert workflow still assumed it was or would be).
  • Add a release workflow section to both CONTRIBUTING.md files (fixes Update contributing guide #156).

@egpbos
add Science/Research as intended audience
25f15b1 
Fixes #111.
@egpbos
harmonize CONTRIBUTING.md files in template and generated
bba2cc0 
Also fix a link to a header that no longer existed in the generated project.
@egpbos
remove .zenodo.json and all references to it
4c25c48 
CITATION.cff replaces it fully, also for integration with Zenodo. See
citation-file-format/citation-file-format#374
or https://twitter.com/zenodo_org/status/1420357001490706442 for more
information on this.

Concretely, this commit:
- Removes .zenodo.json from the template repo
- Removes all references to it in README files (also in the package)
- Updates the cffconvert GitHub Actions workflow to only validate,
  whereas previously it also checked the .zenodo.json file for
  consistency
- Simplifies the 02_citation.md "next steps" issue template, because
  consistency with .zenodo.json no longer has to be checked.
@egpbos
add release workflow to CONTRIBUTING.md
f9dfef5 
Both for the template and for the package. Inspired by and fixes #156.
abelsiqueira
abelsiqueira approved these changes Jan 3, 2024
View reviewed changes
Copy link
Member

@abelsiqueira abelsiqueira left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@egpbos egpbos merged commit 455ae35 into main Jan 10, 2024
16 checks passed
@sjvrijn sjvrijn deleted the all_the_small_things branch May 3, 2024 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abelsiqueira abelsiqueira abelsiqueira approved these changes

@jspaaks jspaaks Awaiting requested review from jspaaks

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update contributing guide which Intended Audience under classifiers in setup.py?
2 participants
@egpbos @abelsiqueira