README.md: Add DOI and citation guide#4761
Conversation
7ad8816 to
46ec1cc
Compare
FlorianHockmann
left a comment
There was a problem hiding this comment.
While looking how other software projects handle this, I learned that GitHub apparently has built in support for this with CITATION.cff files: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
So we could also move the information (apart from the badge) into such a file probably instead of adding it to the README as it should only affect a small percentage of our users.
But that's just an idea I'm also completely fine with having it in the README.
|
TensorFlow also has a dedicated page for citation instruction https://www.tensorflow.org/about/bib which I guess serves this purpose well enough, but most citeable reposities I have seen usually have citation section in README. |
Signed-off-by: Boxuan Li <liboxuan@connect.hku.hk>
46ec1cc to
1cee599
Compare
Closes #4760
Thank you for contributing to JanusGraph!
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
For all changes:
master)?For code changes:
For documentation related changes: