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

"Conventions used in the compiler" #12

Closed
7 of 8 tasks
nikomatsakis opened this issue Jan 18, 2018 · 1 comment · Fixed by #273
Closed
7 of 8 tasks

"Conventions used in the compiler" #12

nikomatsakis opened this issue Jan 18, 2018 · 1 comment · Fixed by #273
Labels
Medium Might require some prior knowledge or code reading

Comments

@nikomatsakis
Copy link
Contributor

nikomatsakis commented Jan 18, 2018

Some of this material exists already scattered about, and/or maybe this overlaps with the glossary, but I think it'd be helpful to try and capture some common conventions.

Here are some things I'm thinking about:

  • How to format code (document the test infrastructure #47)
    • Um... kind of a mess. Hopefully we'll move to rustfmt.
  • Naming conventions (maybe this should just be in the glossary, actually?)
    • the cx suffix -- short for "context"
    • 'tcx and 'gcx -- mostly direct elsewhere for detailed explanation?
  • When to add/avoid adding dependencies from crates.io? What is the vetting process?
    • Whitelisting?
  • What else?
@nikomatsakis nikomatsakis mentioned this issue Jan 18, 2018
20 tasks
@mark-i-m mark-i-m added the help wanted Extra attention is needed label Jan 31, 2018
@mark-i-m
Copy link
Member

cc #47 (adds conventions.md)

@mark-i-m mark-i-m added the Medium Might require some prior knowledge or code reading label Mar 16, 2018
@mark-i-m mark-i-m removed the help wanted Extra attention is needed label Jan 23, 2019
david0u0 pushed a commit to david0u0/rustc-guide that referenced this issue Aug 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Medium Might require some prior knowledge or code reading
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants