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

Add words about citation to affiliated package review #229

Merged
merged 2 commits into from
Jan 20, 2022
Merged

Conversation

kelle
Copy link
Member

@kelle kelle commented Dec 23, 2021

Adds one sentence to the Documentation section of the Affiliated Package review process. (I will also open an PR on the website to provide a link to some resources.)

@kelle kelle requested review from dhomeier and pllim December 23, 2021 16:32
@kelle
Copy link
Member Author

kelle commented Dec 24, 2021

Issues opened to request those coordinated packages add a CITATION file. EDIT: Links in Pey Lian's comment below.

@pllim
Copy link
Member

pllim commented Dec 24, 2021

I cannot edit your post above, but this is an easier way to cross-ref issues across GitHub (also, the third URL was wrong):

@dhomeier
Copy link
Contributor

dhomeier commented Dec 24, 2021

Re: guidelines on actually how to cite, we certainly should not set any strict rules, but some hints on what could get inside the CITATION.x file could perhaps be useful.
E.g.

This can consist of simply providing a Zenodo link if the package has an entry (highly recommended), or the bibliography of papers describing it. Full BibTeX entries will be useful for many users publishing results based on your package.

Needs of course some good balance of minimal info and making too lengthy prescriptions; also wondering if the details are better put into the guidelines (unless both are to be kept closely sync'ed).
And those hints are certainly included in extensive detail in the Astrobetter link, but the two – Zenodo + BibTeX – were just the most obvious ones when looking at the present examples.

@kelle
Copy link
Member Author

kelle commented Dec 24, 2021

I added more words to the website. Check out astropy/astropy.github.com#460

Copy link
Contributor

@dhomeier dhomeier left a comment

Choose a reason for hiding this comment

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

Good to go once astropy/astropy.github.com#460 is done!

@dhomeier
Copy link
Contributor

Should we merge this as well to keep in sync with astropy/astropy.github.com#460?
The latter is the more visible one to (potential) affiliated package maintainers anyway.

@kelle
Copy link
Member Author

kelle commented Jan 20, 2022

I vote yes but am not sure of who should push the button. @pllim ?

@pllim
Copy link
Member

pllim commented Jan 20, 2022

Sure, though I see healpix and reproject are still lagging. I cannot merge here.

@kelle
Copy link
Member Author

kelle commented Jan 20, 2022

I am happy with the discussion having started in both places. Merging.

@kelle kelle merged commit 11fa5a0 into astropy:main Jan 20, 2022
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.

None yet

3 participants