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

Creating a Codemeta JSON file #676

Merged
merged 4 commits into from
Sep 12, 2019
Merged

Conversation

namurphy
Copy link
Member

@namurphy namurphy commented Sep 10, 2019

This PR adds a codemeta JSON file that contains the metadata for our project. I created this initially with their online tool (which I had to use Chrome for instead of Firefox; see codemeta/codemeta.github.io#18), and added terms from the codemeta schema to my heart's content. Things I still need to do are:

  • Add updating codemeta file to release procedure in docs
  • Add a changelog entry

Closes #622.

I put some of the data for funding agencies in a little ahead of time,
but decided to do it now since I was able to look things up.  The NASA
HDEE and NSF CSSI proposals are currently pending.  I started working
on PlasmaPy through a DOE grant, and also did some work through an
internal Smithsonian Institution grant.
@namurphy namurphy added status: nearing completion Availability needs changelog entry See: https://docs.plasmapy.org/en/latest/contributing/changelog_guide.html labels Sep 10, 2019
@namurphy namurphy added this to the v0.3.0 milestone Sep 10, 2019
@namurphy
Copy link
Member Author

The codemeta standard is still relatively new and will probably evolve, so we should make sure to check before each release to make sure the standard hasn't changed.

We might want to add a separate issue to add in all of the contributors. Hopefully, metadata in codemeta.json will be able to be read in by Zenodo to autofill a bunch of the things, like the list of contributors.

Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

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

LGTM for now!

"isAccessibleForFree": true,
"issueTracker": "https://github.com/PlasmaPy/plasmapy/issues",
"readme": "https://github.com/PlasmaPy/PlasmaPy/blob/master/README.md",
"developmentStatus": "WIP",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"developmentStatus": "WIP",
"developmentStatus": "The WIPpest",

I added a bit about Codemeta, made a few changes about the Zenodo
procedure, and made some formatting changes.
@codecov
Copy link

codecov bot commented Sep 11, 2019

Codecov Report

Merging #676 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #676   +/-   ##
=======================================
  Coverage   95.03%   95.03%           
=======================================
  Files          58       58           
  Lines        4674     4674           
=======================================
  Hits         4442     4442           
  Misses        232      232

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6a438d...83289a7. Read the comment docs.

@namurphy
Copy link
Member Author

Ok, I think that's all that I wanted to include with this one. If it looks good, we can do a squash merge whenever.

@StanczakDominik StanczakDominik merged commit 90175b0 into PlasmaPy:master Sep 12, 2019
@namurphy namurphy deleted the codemeta branch August 14, 2021 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs changelog entry See: https://docs.plasmapy.org/en/latest/contributing/changelog_guide.html
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a CodeMeta instance file
2 participants