Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add CITATION.CFF #61

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

Merged
merged 4 commits into from
Dec 18, 2021
Merged

Add CITATION.CFF #61

merged 4 commits into from
Dec 18, 2021

Conversation

dihm
Copy link
Contributor

@dihm dihm commented Aug 31, 2021

Here is my first pass at a citation file. I've confirmed locally that there are not syntax errors. I do not think everything is complete, but there is enough to indicate what is possible. Happy to implement any modifications necessary.

As best I can tell, there isn't an obvious way to test how github will process the file other than locally checking that syntax is valid using stuff described here.

This addresses #60, for this repo at least.

@dihm dihm added the documentation Improvements or additions to documentation label Aug 31, 2021
@dihm dihm requested a review from philipstarkey August 31, 2021 19:18
@dihm
Copy link
Contributor Author

dihm commented Oct 22, 2021

I stand corrected. You can see how github interprets the CITATION.CFF file by looking at the code landing page for the branch that is being merged. It seems github doesn't use most of the information provided, but at least it is there. At least for now, only one "citation" is supported, so I went ahead and put the Rev Sci Inst as the most general citation.

If there is anything that needs to be changed, particularly with respect to "referenced software packages" or keywords I could/should include, let me know. Else I'm going to merge by end of next week.

@dihm
Copy link
Contributor Author

dihm commented Oct 25, 2021

As a follow up question, should we ultimately have one of these files in each repository? If we do, would we want to tweak the references section to match the dependencies of that particular repo?

dihm and others added 4 commits November 15, 2021 16:51
I've confirmed locally that there are not syntax errors.
I do not think everything is complete, but there is enough to indicate
what is possible.
@dihm
Copy link
Contributor Author

dihm commented Nov 15, 2021

@philipstarkey Unless you can think of more references to add, I'm ready to merge this one in and move on to other things.

@dihm dihm merged commit 13844c2 into labscript-suite:master Dec 18, 2021
@dihm dihm deleted the citation_file branch December 18, 2021 12:14
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.

2 participants