Commit Graph

157 Commits

Author SHA1 Message Date
Henry Boisdequin
bf40ac6877 Make opening sentence friendlier for new contributors
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-09 08:27:56 +05:30
Henry Boisdequin
469c030260 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-09 08:06:15 +05:30
follower
a7bd6c449a
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-28 04:05:39 +13:00
Yuki Okushi
85072e3303
Update reference to CONTRIBUTING.md 2020-07-07 17:12:22 +09:00
Valentin
df43dcd7d4 Fix "getting started" link
The previous link is 404.
2020-07-03 11:44:37 +02:00
mark
3f6928f1f6 move contributing.md to rustc-dev-guide and point at getting started 2020-06-17 14:25:00 -05:00
Dylan DPC
53702a67e2
Rollup merge of #71864 - mibac138:patch-1, r=jonas-schievink
Update link in contributing.md
2020-05-04 03:15:03 +02:00
Dylan DPC
34421fd1af
Rollup merge of #71844 - flip1995:subtree_clippy_doc, r=oli-obk
List Clippy as a subtree, instead of a submodule

r? @oli-obk
2020-05-04 03:15:01 +02:00
Michael
bdbd218b1f
Update link in contributing.md 2020-05-04 00:40:15 +02:00
flip1995
1b155623d8
List Clippy as a subtree, instead of a submodule 2020-05-03 15:58:30 +02:00
Dylan MacKenzie
5577b3554d Suggest stage 1 if stage 0 fails 2020-04-28 10:14:56 -07:00
Dylan MacKenzie
23dbd33d93 Direct contributors to try stage 0 rustdoc first 2020-04-28 08:55:41 -07:00
Oliver Scherer
7928c45c06 Address reviews 2020-04-02 18:33:48 +02:00
Oliver Scherer
df91b40b43 Address review comments 2020-04-02 17:20:56 +02:00
Oliver Scherer
59cfb8035c Triple backticks 2020-04-01 17:45:47 +02:00
Oliver Scherer
af553528ad Explain that you have to specify path and repository during subrepo synchronizations 2020-04-01 17:33:20 +02:00
Oliver Scherer
521eb0df67 Git subtree is upstream, no need to install 2020-04-01 16:18:35 +02:00
Oliver Scherer
56d0c81c75 s/subrepo/subtree/ 2020-04-01 14:53:10 +02:00
Oliver Scherer
04c8191719 Explain how to work with subrepos 2020-04-01 14:36:33 +02:00
Mazdak Farrokhzad
39c6405097
Rollup merge of #69747 - spastorino:rename-rustc-guide, r=pietroalbini
Rename rustc guide

This is in preparation for https://github.com/rust-lang/rustc-guide/issues/470
Needs to be merged after we actually rename the guide.

Have used this to rename:

`git grep -l 'rustc_guide' | xargs sed -i 's/rustc_guide/rustc_dev_guide/g'`
`git grep -l 'rustc-guide' | xargs sed -i 's/rustc-guide/rustc-dev-guide/g'`
`git grep -l 'rustc guide' | xargs sed -i 's/rustc guide/rustc dev guide/g'`
2020-03-12 16:32:19 +01:00
Santiago Pastorino
b3b32b74bc
rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org 2020-03-10 17:08:18 -03:00
Santiago Pastorino
9d4fdba8be
Rename rustc guide to rustc dev guide 2020-03-10 17:08:16 -03:00
Santiago Pastorino
0037f4e37c
Rename rustc-guide to rustc-dev-guide 2020-03-10 17:08:10 -03:00
Chris Simpkins
c60d581eb1 update x.py tidy testing command 2020-03-09 23:00:41 -04:00
Jacob Rothstein
2a79ed0b49
[docs] remind bug reporters to update nightly 2020-01-30 17:25:58 -08:00
Matthew Kraai
21e636f188 Remove redundant link texts 2019-12-26 05:04:46 -08:00
Dylan DPC
77f2ac4a49
Update CONTRIBUTING.md 2019-11-28 01:26:45 +01:00
Dylan DPC
2a7dc5ec7f
Update CONTRIBUTING.md 2019-11-28 01:23:39 +01:00
Mark Lodato
9b78191e08 Clarifies how to tag users for assigning PRs 2019-11-27 17:19:09 -05:00
Yuki Okushi
1d2a314ef5 Update link on CONTRIBUTING.md 2019-11-07 06:48:28 +09:00
Yuki Okushi
bd82de0de6
Rollup merge of #65007 - BO41:keywords, r=nikomatsakis
Mention keyword closing policy

closes #59233 / https://github.com/rust-lang/rust/issues/59233#issuecomment-478362693

rewording suggestions welcome

> Also in the referenced issue, the commit number of the new commit
> that could close that issue is not really informative. The PR number itself appeared in the issue
> is more informative and concise.

@lzutao what do you mean with that? Is this fixed by the new "May be fixed by #XXXXX"?
2019-10-23 17:14:29 +09:00
BO41
1c85b45117
Apply suggested wording
to better describe the situation
2019-10-18 16:55:08 +00:00
BO41
59ce359c8f
Fix typo 2019-10-02 21:31:00 +00:00
BO41
cabcd99476 Mention keyword closing policy 2019-10-02 17:55:06 +02:00
BO41
2ab7a67326 Replace mentions of IRC with Discord 2019-10-02 17:28:48 +02:00
Eric Huss
06c3256a6b Update cargo-vendor usage 2019-07-09 16:12:41 -07:00
Mazdak Farrokhzad
df18e190be
Rollup merge of #59234 - stepnivlk:add-no_merge_policy, r=oli-obk
Mention `no merge policy` in the CONTRIBUTING guide

Issue: https://github.com/rust-lang/rust/issues/59233
2019-03-31 16:10:36 +02:00
stepnivlk
a4b67ee195 Mention no merge policy in the CONTRIBUTING guide 2019-03-16 19:16:27 +01:00
varkor
037596c4ce Fix capitalisation problem 2019-03-14 01:20:41 +00:00
varkor
3a00649256 Move rollup description earlier 2019-03-14 01:17:49 +00:00
varkor
308a002eb1 Make all references to @bors or users links 2019-03-14 01:13:26 +00:00
varkor
eadb8443f3 Update r+ syntax 2019-03-14 01:09:32 +00:00
varkor
6f3fda9d1d Add links to @rust-highfive and @bors 2019-03-14 01:07:00 +00:00
varkor
205ab0c260 Add a link to the Discord and Zulip servers 2019-03-14 01:04:19 +00:00
varkor
6e449dacea Remove trailing newlines 2019-03-14 01:03:11 +00:00
varkor
ff5e31ffb5 Fix a broken link to the rustc-guide 2019-03-14 01:02:56 +00:00
Philipp Hansch
36f665239d
Fix more nursery links in CONTRIBUTING.md 2019-02-21 20:58:56 +01:00
Philipp Hansch
4867a8c4fa
Update miri links
Miri has been moved to `rust-lang` a couple of days ago.
2019-02-21 19:26:45 +01:00
mark
48bee07768 make the contribution doc reference the guide more; deduplication 2019-01-15 20:02:28 -06:00
Jens Hausdorf
38667104d6
Fix security link in CONTRIBUTING to its new place
avoiding an 404
2018-12-09 15:25:23 +01:00