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

Updates read.me to include citation section #500

Merged
merged 2 commits into from
Oct 6, 2020
Merged

Updates read.me to include citation section #500

merged 2 commits into from
Oct 6, 2020

Conversation

SamFritz
Copy link
Member

@SamFritz SamFritz commented Oct 5, 2020

GitHub issue(s):

This PR addresses Issue-497: Update Read.me w/ citation information

What does this Pull Request do?

Adds in a section in the AUT read.me to identify how folks should cite AU tools. Implementation based on discussion in the ticket, specifically how how citation should be formatted.

Interested parties

@ianmilligan1 thanks for your final review; please feel free to adjust any of the wording!

@SamFritz SamFritz requested a review from ianmilligan1 October 5, 2020 15:10
@SamFritz SamFritz self-assigned this Oct 5, 2020
@codecov
Copy link

codecov bot commented Oct 5, 2020

Codecov Report

Merging #500 into main will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #500   +/-   ##
=========================================
  Coverage     88.85%   88.85%           
  Complexity       57       57           
=========================================
  Files            43       43           
  Lines          1014     1014           
  Branches         86       86           
=========================================
  Hits            901      901           
  Misses           74       74           
  Partials         39       39           

Copy link
Member

@ianmilligan1 ianmilligan1 left a comment

Choose a reason for hiding this comment

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

Looks good! I wonder if we should see what this looks like in a quote (i.e. put > in front of the citation line). Also might help to italicize the venue, i.e. _Proceedings of the ACM/IEEE Joint Conference on Digital Libraries in 2020 (JCDL '20)_.

@SamFritz
Copy link
Member Author

SamFritz commented Oct 5, 2020

checked indentation of citation (so it comes out more of like a block quote) looks good! and will update all citations so Proceedings portion is italicized. Thanks @ianmilligan1!

@ianmilligan1
Copy link
Member

Great, looks good to me @SamFritz. I will let @ruebot do a final review + merge when he is available as I think of him as the keeper of all things AUT.

@ruebot ruebot merged commit 5d2bf57 into main Oct 6, 2020
@ruebot ruebot deleted the issue-497 branch October 6, 2020 12:59
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.

3 participants