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 CITATION.bib file to make citing RMG easier #2346

Closed

Conversation

JacksonBurns
Copy link
Contributor

Motivation or Problem

RMG-py provides a list of citations, but does not take advantage of the GitHub Cite this Repository feature which automatically provides BibTex files with appropriate citations to users.

Description of Changes

This PR adds a single CITATION.cff file that is (hopefully) correctly formatted and accurate.

Testing

After merging, GitHub will automatically detect the file and add a Cite this Repository button, and any formatting/accuracy issues will then be obvious.

Reviewer Tips

The CITATION.cff file format is described here.

@yunsiechung
Copy link
Contributor

I made a pull request (#2351) to add the RMG database paper (doi:10.1021/acs.jcim.2c00965) to the "How to cite" section in the README.md file. Will you add that to the CITATION.cff file?

@JacksonBurns
Copy link
Contributor Author

Additional paper added. When pushed, it renders a button like this on the repository:
image
See it for yourself here.

@JacksonBurns JacksonBurns changed the title Add CITATION.cff file to make citing RMG easier Add CITATION.bib file to make citing RMG easier Dec 17, 2022
@yunsiechung
Copy link
Contributor

Looks good!
It looks like the branch is be behind the main branch. Could you rebase it with the latest main branch and push again?

@JacksonBurns
Copy link
Contributor Author

Done!

@yunsiechung
Copy link
Contributor

yunsiechung commented Dec 17, 2022

I think we usually rebase the branch with main and force-push the branch, so we don't have an additional commit like 1f182aa.

If you RMG's official git repo is called official, it will follow:
git fetch official
git rebase official/main
git push -f official [name_of_the_branch_to_push]

Will you undo your last commit (git reset HEAD~1) and follow the procedure above?
Also, the first two commits can be combined as one commit to minimize the number of commits.

@JacksonBurns
Copy link
Contributor Author

Can you squash and merge instead? Seems cleaner than undoing a commit, combining two commits, and then rebasing.

@JacksonBurns JacksonBurns mentioned this pull request Jan 18, 2023
@JacksonBurns
Copy link
Contributor Author

Moved to #2357

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

2 participants