feat: adding BibTex entry to cite Substrait

[vibhatha]

This PR adds a subsection to Community section in web site.

Closes #480

[github-actions]

ACTION NEEDED

Substrait follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

[westonpace]

I don't know much about bibtex so I'll need to defer to someone more academically minded. This seems reasonable to put on the site.

[mbrobbel]

How about using https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files? Nevermind, this is for the site not the repo.

[westonpace]

I just saw the conversation on Slack. Can you add the url attribute per @drin 's suggestion?

[westonpace]

How about using https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files? Nevermind, this is for the site not the repo.

Adding a cittation for the repo as well seems worthwhile

[kabicm]

Thanks for adding this!

I would have few suggestions:

• would avoid hardcoding the full date into the year field, but rather have a month and day fields defined as well.
• For the date of the repo creation, I see 31. August 2021 (see created_at field here: https://api.github.com/repos/substrait-io/substrait).
• We can add the accessed date as a note.

For example, something along these lines:

@misc{substrait,
  author = {substrait-io},
  title = {Substrait: Cross-Language Serialization for Relational Algebra},
  year = {2021},
  month=aug,
  day = {31},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/substrait-io/substrait}},
  note = {Accessed on <add the date here>.}
}

For convenience, we could add a CITATION.cff file, so that github would automatically generate the citation, as proposed here: https://academia.stackexchange.com/questions/14010/how-do-you-cite-a-github-repository.

[vibhatha]

Thanks @mbrobbel and @kabicm for the suggestions. I will update the PR.

[vibhatha]

@kabicm I think the note field should come from the authors who cite this. It may be less practical to put an accessed date. What do you think?

[kabicm]

@vibhatha Thanks for taking a look into the suggestions!

I agree, most users might blindly copy-paste without filling in the access date which might not be as practical.

In that case, we can completely remove the note field and potentially mention in a comment that users can optionally add a field with an access date e.g. as note = {Accessed on <add the date here>.}. It's up to you :)

[vibhatha]

I have added a CITATION.cff file, and used the very first release date of Substrait as the data-released. I used their online tool to generate this file.

@kabicm @mbrobbel could you please take a look.

Also @jacques-n could you please also verify if the data entered is accurate and if there are any missing fields?

[vibhatha]

@vibhatha Thanks for taking a look into the suggestions!

I agree, most users might blindly copy-paste without filling in the access date which might not be as practical.

In that case, we can completely remove the note field and potentially mention in a comment that users can optionally add a field with an access date e.g. as note = {Accessed on <add the date here>.}. It's up to you :)

Thanks for your suggestion, @kabicm.

In case of authors who just want to copy/paste and wouldn't require the note field will always have to remove that entry. To keep it simple, I think it would be good to remove that field. Authors can always add that field. Hope this clarifies the choice 🙂

[kabicm]

Looks great, thanks @vibhatha for the work!

[westonpace]

Thanks for creating this! Two small requests and then I think we're good.

[drin]

I think everything looks good! I just made 1 suggestion to add the url attribute to the explicit bibtex citation

[westonpace]

It seems discussion has settled here. Thanks for creating this @vibhatha