search

spacetelescope / style-guides

An opinionated guide on how we work.
Creative Commons Attribution 4.0 International
55 stars 33 forks source link

Description of how to cite the software #90

Closed brechmos-stsci closed 5 years ago

brechmos-stsci commented 5 years ago

Descriptions were added of how to cite the software repo for journal articles etc.

Fixes #89

arfon commented 5 years ago

@brechmos-stsci - is this PR still a work in progress?

brechmos-stsci commented 5 years ago

It is. I have been in class all week so have not been working on it.

brechmos-stsci commented 5 years ago

I talked with @arfon about what we should suggest here and what astropy is doing probably makes the most sense. So, this PR is to formalize that.
@arfon @stscicrawford Feel free to review

brechmos-stsci commented 5 years ago

@arfon Ummm.... I think that is duplicating information in the CITATION file, no? I can maybe see adding a comment in the software-versioning.md in the Citing Software section to say that the README file should include a short paragraph to see the CITATION file and include the zenodo badge.

The current thought is that the CITATION file contains the bibtex entry etc, so don't want to duplicate that info in the README file.

arfon commented 5 years ago

@arfon Ummm.... I think that is duplicating information in the CITATION file, no?

Yes, but I come from the school of make it as easy as possible for people to do the right thing 😁.

I can maybe see adding a comment in the software-versioning.md in the Citing Software section to say that the README file should include a short paragraph to see the CITATION file and include the zenodo badge.

👍 that sounds like a good option to me.

arfon commented 5 years ago

:wave: @brechmos-stsci - is this ready to ship?

brechmos-stsci commented 5 years ago

Yes, I believe it is good to go, if you are good with it.

arfon commented 5 years ago

:shipit:

arfon commented 5 years ago

🎉