|
| 1 | +# Contributing to the Rust website |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the Rust site! |
| 4 | + |
| 5 | +As a reminder, all contributors are expected to follow our [Code of Conduct][coc]. |
| 6 | + |
| 7 | +[coc]: http://www.rust-lang.org/conduct.html |
| 8 | + |
| 9 | +## What this repo isn't |
| 10 | + |
| 11 | +The documentation, `doc.rust-lang.org`, is built from the [docs in |
| 12 | +tree][rustdocs]. |
| 13 | + |
| 14 | +The [playpen][playpen] source lives in [its own repo][playsrc]. |
| 15 | + |
| 16 | +The [crates.io][crates] source lives [on github][cratessrc]. |
| 17 | + |
| 18 | +[crates]: https://crates.io/ |
| 19 | +[cratessrc]: https://github.com/rust-lang/crates.io |
| 20 | +[playpen]: https://play.rust-lang.org/ |
| 21 | +[playsrc]: https://github.com/rust-lang/rust-playpen/ |
| 22 | +[rustdocs]: https://github.com/rust-lang/rust/tree/master/src/doc |
| 23 | + |
| 24 | +## Troubleshooting this site |
| 25 | + |
| 26 | +Every page has the timestamp at which it was last generated embedded in the |
| 27 | +source code. You can view a page's source by right clicking and selecting |
| 28 | +"view source". The timestamp will look like `<!-- Page last generated |
| 29 | +2015-08-04 12:00:42 -0700 -->`. |
| 30 | + |
| 31 | +## Bug Reports |
| 32 | + |
| 33 | +Opening an issue is as easy as following [this |
| 34 | +link](https://github.com/rust-lang/rust-www/issues/new) and filling out the fields. |
| 35 | + |
| 36 | +## Pull Requests |
| 37 | + |
| 38 | +Pull requests are the primary mechanism we use to change Rust. GitHub itself |
| 39 | +has some [great documentation][pull-requests] on using the Pull Request |
| 40 | +feature. We use the 'fork and pull' model described there. |
| 41 | + |
| 42 | +[pull-requests]: https://help.github.com/articles/using-pull-requests/ |
| 43 | + |
| 44 | +Please make pull requests against the `master` branch. |
| 45 | + |
| 46 | +All pull requests are reviewed by another person. We have a bot, |
| 47 | +@rust-highfive, that will automatically assign a random person to review your |
| 48 | +request. |
| 49 | + |
| 50 | +If you want to request that a specific person reviews your pull request, |
| 51 | +you can add an `r?` to the message. For example, Steve usually reviews |
| 52 | +documentation changes. So if you were to make a documentation change, add |
| 53 | + |
| 54 | + r? @steveklabnik |
| 55 | + |
| 56 | +to the end of the message, and @rust-highfive will assign @steveklabnik instead |
| 57 | +of a random person. This is entirely optional. |
0 commit comments