Skip to content

Conversation

@carmocca
Copy link
Contributor

@carmocca carmocca commented Aug 26, 2021

What does this PR do?

Context:

https://github.blog/2021-08-19-enhanced-support-citations-github/
https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files

Spec:
https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md

See the result in:
https://github.com/PyTorchLightning/pytorch-lightning/tree/github/cff

to the right, below "About" there is now a button "cite this repository"

image

APA:

William, F., & The PyTorch Lightning team. (2019). PyTorch Lightning (Version 1.4.4) [Computer software]. https://doi.org/10.5281/zenodo.3828935`

BibTeX

@misc{William_PyTorch_Lightning_2019,
author = {William, Falcon and {The PyTorch Lightning team}},
doi = {10.5281/zenodo.3828935},
month = {3},
title = {{PyTorch Lightning}},
url = {https://github.com/PyTorchLightning/pytorch-lightning},
year = {2019}
}

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • [n/a] Did you write any new necessary tests? (not for typos and docs)
  • [n/a] Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • [n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

@carmocca carmocca added the feature Is an improvement or enhancement label Aug 26, 2021
@carmocca carmocca added this to the v1.5 milestone Aug 26, 2021
@carmocca carmocca self-assigned this Aug 26, 2021
@Borda
Copy link
Collaborator

Borda commented Aug 26, 2021

exactly he same @justusschock was speaking last week :]

@codecov
Copy link

codecov bot commented Aug 26, 2021

Codecov Report

Merging #9139 (b2bdbea) into master (b13749b) will increase coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #9139   +/-   ##
======================================
  Coverage      92%     92%           
======================================
  Files         176     176           
  Lines       14786   14810   +24     
======================================
+ Hits        13634   13663   +29     
+ Misses       1152    1147    -5     

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@mergify mergify bot added the ready PRs ready to be merged label Aug 27, 2021
Copy link
Collaborator

@Borda Borda left a comment

Choose a reason for hiding this comment

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

let's enable the zenodo first

Co-authored-by: Jirka Borovec <[email protected]>
@carmocca carmocca merged commit 54e95d3 into master Sep 7, 2021
@carmocca carmocca deleted the github/cff branch September 7, 2021 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature Is an improvement or enhancement ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants