Auto merge of #24341 - rasviitanen:docfix, r=Manishearth

Update HACKING_QUICKSTART doc

<!-- Please describe your changes on the following line: -->
* Some of the old links in `HACKING_QUICKSTART` were outdated.
* Added some information about `test-tidy`.
* Rust has moved from IRC to Discord, so the IRC channel is replaced with a section on where to find the Discord server.
---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `___` with appropriate data: -->
- [X] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [ ] These changes fix ___ (no related issule)

<!-- Either: -->
- [ ] There are tests for these changes OR
- [X] These changes do not require tests because it's documentation :)

<!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.-->

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/24341)
<!-- Reviewable:end -->
This commit is contained in:
bors-servo 2019-10-01 22:01:34 -04:00 committed by GitHub
commit 92809c32d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -61,9 +61,9 @@ This guide only covers the most important options. Be sure to look at all the av
Even if you have never seen any Rust code, it's not too hard to read Servo's code. But there are some basics things one must know:
- [Match](https://doc.rust-lang.org/stable/rust-by-example/flow_control/match.html) and [Patterns](https://doc.rust-lang.org/book/ch18-00-patterns.html)
- [Options](https://rustbyexample.com/std/option.html)
- [Expression](https://rustbyexample.com/expression.html)
- [Traits](https://rustbyexample.com/trait.html)
- [Options](https://doc.rust-lang.org/stable/rust-by-example/std/option.html)
- [Expression](https://doc.rust-lang.org/stable/rust-by-example/expression.html)
- [Traits](https://doc.rust-lang.org/stable/rust-by-example/trait.html)
- That doesn't sound important, but be sure to understand how `println!()` works, especially the [formatting traits](https://doc.rust-lang.org/std/fmt/#formatting-traits)
This won't be enough to do any serious work at first, but if you want to navigate the code and fix basic bugs, that should do it. It's a good starting point, and as you dig into Servo source code, you'll learn more.
@ -71,7 +71,7 @@ This won't be enough to do any serious work at first, but if you want to navigat
For more exhaustive documentation:
- [doc.rust-lang.org](https://doc.rust-lang.org)
- [rust by example](https://rustbyexample.com)
- [rust by example](https://doc.rust-lang.org/stable/rust-by-example)
## Cargo and Crates
@ -96,7 +96,7 @@ source = "git+https://github.com/servo/rust-stb-image#f4c5380cd586bfe16326e05e25
This file should not be edited by hand. In a normal Rust project, to update the git revision, you would use `cargo update -p stb_image`, but in Servo, use `./mach cargo-update -p stb_image`. Other arguments to cargo are also understood, e.g. use --precise '0.2.3' to update that crate to version 0.2.3.
See [Cargo's documentation about Cargo.toml and Cargo.lock files](https://doc.crates.io/guide.html#cargotoml-vs-cargolock).
See [Cargo's documentation about Cargo.toml and Cargo.lock files](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html).
## Working on a Crate
@ -248,6 +248,14 @@ To run a test:
./mach test-wpt tests/wpt/yourtest
```
For your PR to get accepted, source code also has to satisfy certain tidiness requirements.
To check code tidiness:
```
./mach test-tidy
```
### Updating a test:
In some cases, extensive tests for the feature you're working on already exist under tests/wpt:
@ -287,13 +295,13 @@ See the [debugging guide](./debugging.md) to get started in how to debug Servo.
## Ask questions
### IRC
IRC channels (irc.mozilla.org):
### IRC channels (irc.mozilla.org)
- #servo
- #rust
- #cargo
### Discord servers
The official [Rust Discord server](https://discordapp.com/invite/rust-lang) is a great place to ask Rust specific questions, including questions related to cargo.
### Mailing list