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

Added GitHub citation file. #614

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added GitHub citation file. #614

wants to merge 2 commits into from

Conversation

mainrs
Copy link

@mainrs mainrs commented Dec 10, 2023

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Docs change / refactoring / dependency upgrade

Motivation and Context / Related issue

GitHub introduces the citation file format to make it easier to discover and work with software that can be cited. Following the already provided citation inside the README, I created the corresponding citation file.

Similar to https://github.com/pytorch/pytorch, a new Cite this repository button will now be displayed on the right-hand side of the webpage inside the About section (see attached screenshot).

There are two things I'd like to point out:

  1. The citation type is now software instead of the original article. This can be changed using a preferred-citation key according to the official GitHub documentation.
  2. PyTorch has an organization attached to its citation. If this is applicable here too, then the file needs to be edited.

image

How Has This Been Tested (if it applies)

Checklist

  • The documentation is up-to-date with the changes I made.
  • I have read the CONTRIBUTING document and completed the CLA (see CONTRIBUTING).
  • All tests passed, and additional code has been covered with new tests.

@facebook-github-bot
Copy link
Contributor

Hi @mainrs!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@HuanyuZhang
Copy link
Contributor

@mainrs Thanks for contributing to the citation file. Do you mind signing our CLA, otherwise it is impossible to merge your code? Thx!

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