mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b26371c21a
rust/CONTRIBUTING.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

44 lines
2.4 KiB
Markdown
Raw Normal View History

CONTRIBUTING.md redux This redux of CONTRIBUTING.md adds in more information, including subsuming both compliment-bugreport.md and Note-development-policy in the wiki. I only glanced at the broad TOC of Note-development-policy, and did not use the text as the basis for the re-write. This will then address the last outstanding part of #5831.
2015-02-13 11:26:44 -06:00
# Contributing to Rust
syntax: Add the Bug Report HOWTO URL to the ICE message And also reference the bug report HOWTO in CONTRIBUTING.md
2013-10-21 14:10:57 -05:00
Update CONTRIBUTING.md Fixes #77215 As mentioned in #77215, the current CONTRIBUTING.md links to the rustc-dev-guide. Even though the rustc-dev-guide has lots of useful information for contributors, one is already confused by reading the first line of the current CONTRIBUTING.md. > To get started, read the [Getting Started] guide in the [rustc-dev-guide]. This line tells the contributor to go and read the rustc-dev-guide. What is the rustc-dev-guide? What does rustc even mean? These are some of the questions that went into my head when reading this line as a first time contributor. By explaining what the rustc-dev-guide is and some platforms to get help, a new contributor understands what the first step is and the process is much clearer. The `About the [rustc-dev-guide]` section explains what the rustc-dev-guide is, what rustc is, and the purpose out of reading the guide. The `Getting help` section points the user to some places where they can get help, find a mentor, and introduce themsevles.
2021-03-07 23:56:05 -06:00
Thank you for your interest in contributing to Rust! There are many ways to contribute
and we appreciate all of them.
syntax: Add the Bug Report HOWTO URL to the ICE message And also reference the bug report HOWTO in CONTRIBUTING.md
2013-10-21 14:10:57 -05:00
Give people a single link they can click in the contributing guide Doc Jones mentioned that one of the things making it hard to get started is that the amount of information is overwhelming, between the dev-guide, contributing guide, and discussion platforms. This gives people a single link they can click to ask for help.
2021-11-22 11:55:00 -06:00
The best way to get started is by asking for help in the [#new
members](https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members)
Zulip stream. We have lots of docs below of how to get started on your own, but
the Zulip stream is the best place to *ask* for help.
Link to other resources instead of inlining their information The other places are more accurate and up-to-date. - Link to `std-dev-guide` in CONTRIBUTING.md Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library. - Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme CONTRIBUTING.md has more information and also links the std-dev-guide. - Link to forge for the list of tested platforms; the one in the readme was hopelessly out of date.
2022-12-23 19:03:50 -06:00
Documentation for contributing to the compiler or tooling is located in the [Guide to Rustc
Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the
standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].
syntax: Add the Bug Report HOWTO URL to the ICE message And also reference the bug report HOWTO in CONTRIBUTING.md
2013-10-21 14:10:57 -05:00
Update CONTRIBUTING.md Fixes #77215 As mentioned in #77215, the current CONTRIBUTING.md links to the rustc-dev-guide. Even though the rustc-dev-guide has lots of useful information for contributors, one is already confused by reading the first line of the current CONTRIBUTING.md. > To get started, read the [Getting Started] guide in the [rustc-dev-guide]. This line tells the contributor to go and read the rustc-dev-guide. What is the rustc-dev-guide? What does rustc even mean? These are some of the questions that went into my head when reading this line as a first time contributor. By explaining what the rustc-dev-guide is and some platforms to get help, a new contributor understands what the first step is and the process is much clearer. The `About the [rustc-dev-guide]` section explains what the rustc-dev-guide is, what rustc is, and the purpose out of reading the guide. The `Getting help` section points the user to some places where they can get help, find a mentor, and introduce themsevles.
2021-03-07 23:56:05 -06:00
## About the [rustc-dev-guide]
The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works,
as well as to help new contributors get involved in rustc development. It is recommend
to read and understand the [rustc-dev-guide] before making a contribution. This guide
talks about the different bots in the Rust ecosystem, the Rust development tools,
bootstrapping, the compiler architecture, source code representation, and more.
## [Getting help](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions)
There are many ways you can get help when you're stuck. Rust has many platforms for this:
[internals], [rust-zulip], and [rust-discord]. It is recommended to ask for help on
the [rust-zulip], but any of these platforms are a great way to seek help and even
find a mentor! You can learn more about asking questions and getting help in the
[Asking Questions](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions) chapter of the [rustc-dev-guide].
Update reference to CONTRIBUTING.md
2020-07-04 11:41:21 -05:00
## Bug reports
Did a compiler error message tell you to come here? If you want to create an ICE report,
refer to [this section][contributing-bug-reports] and [open an issue][issue template].
Link to "Contributing to Rust" rather than "Getting Started". Change to link to "Contributing to Rust" chapter of `rustc` Dev Guide, primarily on the basis that the GitHub "first contribution" Issue "pop-up" says "Be sure to review the [contributing guidelines] and [code of conduct]" and links to this file. When/if the guide/"Getting Started" section gets revised to not be `rustc`-specific the linked section can be changed. In the meantime this prevents leading first time contributors into a confusing cul de sac.
2020-09-27 10:05:39 -05:00
[Contributing to Rust]: https://rustc-dev-guide.rust-lang.org/contributing.html#contributing-to-rust
rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
2020-03-09 16:33:04 -05:00
[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
Link to other resources instead of inlining their information The other places are more accurate and up-to-date. - Link to `std-dev-guide` in CONTRIBUTING.md Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library. - Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme CONTRIBUTING.md has more information and also links the std-dev-guide. - Link to forge for the list of tested platforms; the one in the readme was hopelessly out of date.
2022-12-23 19:03:50 -06:00
[std-dev-guide]: https://std-dev-guide.rust-lang.org/
Update reference to CONTRIBUTING.md
2020-07-04 11:41:21 -05:00
[contributing-bug-reports]: https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports
[issue template]: https://github.com/rust-lang/rust/issues/new/choose
Update CONTRIBUTING.md Fixes #77215 As mentioned in #77215, the current CONTRIBUTING.md links to the rustc-dev-guide. Even though the rustc-dev-guide has lots of useful information for contributors, one is already confused by reading the first line of the current CONTRIBUTING.md. > To get started, read the [Getting Started] guide in the [rustc-dev-guide]. This line tells the contributor to go and read the rustc-dev-guide. What is the rustc-dev-guide? What does rustc even mean? These are some of the questions that went into my head when reading this line as a first time contributor. By explaining what the rustc-dev-guide is and some platforms to get help, a new contributor understands what the first step is and the process is much clearer. The `About the [rustc-dev-guide]` section explains what the rustc-dev-guide is, what rustc is, and the purpose out of reading the guide. The `Getting help` section points the user to some places where they can get help, find a mentor, and introduce themsevles.
2021-03-07 23:56:05 -06:00
[internals]: https://internals.rust-lang.org
[rust-discord]: http://discord.gg/rust-lang
[rust-zulip]: https://rust-lang.zulipchat.com
Reference in New Issue Copy Permalink