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

how to cite this guide ? #1534

Closed
zapashcanon opened this issue Dec 23, 2022 · 3 comments · Fixed by #1550
Closed

how to cite this guide ? #1534

zapashcanon opened this issue Dec 23, 2022 · 3 comments · Fixed by #1550

Comments

@zapashcanon
Copy link

Hi,

I'm writing a research paper in which I'd like to cite a chapter of the guide. I've been coming up with the following bibtex entry:

@misc{Con18,
  title = "Guide to Rustc Development",
  author = {The Guide To Rustc Development Contributors},
  howpublished = "\url{https://rustc-dev-guide.rust-lang.org/backend/monomorph.html}",
  year = 2018,
  note = "Accessed: 2022-12-23"
}

The Con18 is what have been autogenerated on the first rendering (it comes from the last word in the author part: Contributors) and is what is going to appear when the paper is cited in the document.

Is there a better list of authors somewhere ? What about including a bibtex entry somewhere in the guide so people don't have to do it each time ?

@JohnTitor
Copy link
Member

We generally use the wording "The Rust Project Developers" or something else ("Contributors" also seems fine to me, but I'm not familiar with the citation much).
Since we have a lot of contributors, listing all the folks isn't realistic (or, listing folks involved in a particular page would be an alternative?).

Maybe it's good time to prepare the citation file on the repo: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

I'll take a look next week.

@JohnTitor
Copy link
Member

An update from me: I couldn't make time to work on this last week. I'm going to revisit this after my vacation (hopefully next week), but feel free to beat me if someone is willing to do it :)

@JohnTitor
Copy link
Member

Okay, I've opened #1550. Since I'm not familiar with citations, feel free to drop your thoughts there, it's definitely helpful!

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 a pull request may close this issue.

2 participants