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

DOC Add explanation for bibtex to contributor guide #1056

Closed
hildeweerts opened this issue Apr 1, 2022 · 0 comments · Fixed by #1136
Closed

DOC Add explanation for bibtex to contributor guide #1056

hildeweerts opened this issue Apr 1, 2022 · 0 comments · Fixed by #1136

Comments

@hildeweerts
Copy link
Contributor

As discussed in #1048, we have agreed that for the BibTex references:

  • We encourage people to simply copy the BibTex entry from the original source (e.g., ACM/Arxiv/etc.)
  • The only change that needs to be made is that the bibtex id should be in the format <author-last-name><4digit-year><keyword>, as this makes it easier to write and review texts compared to more convoluted bibtex id's.

In addition, I would suggest to point new contributors to:

  • The refs.bib file
  • The commands that can be used for referencing. This was already mentioned in this comment, so @iofall may already be working on this. Explaining footcite, footcite:p:, footcite:t:, and .. footbibliography:: would be sufficient.

This should be added to the "Contributing documentation" section of the contributor guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant