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

Move CONTRIBUTING.md to rustc-dev-guide #753

Merged
merged 7 commits into from
Jul 2, 2020

Conversation

mark-i-m
Copy link
Member

cc rust-lang/compiler-team#296 @ecstatic-morse @rust-lang/compiler

This PR moves CONTRIBUTING.md to the rust-dev-guide. It should not merge before #731. The objective is to point all new contributors in one place. In the contributor survey, a surprisingly high number of people (more than half) pointed to CONTRIBUTING.md as a major resource they use to contribute to the compiler, whereas the new "Getting Started" guide is likely a better place to start.

That said, the content in CONTRIBUTING.md is still useful, so we move it here and take the opportunity to also move some other contributing-related chapters together in the guide.

Feedback is welcome.

Copy link
Contributor

@nikomatsakis nikomatsakis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable as a start. I know we've had some debates about where to put "contributing" vs "policies" vs "explaining how the code works" vs "how to build the compiler", and I still feel some uncertainty around that. I know that when I come to the rustc-dev-guide these days, the table of contents itself starts to feel a bit "intimidating" somehow.

I'm usually looking to give somebody a link to explain how some part of the compiler works, and so maybe part of it is that this material doesn't start until fairly far down. I think that having more headings with fewer subbullets would probably help here. (i.e., I approve of this organizational change)

src/SUMMARY.md Outdated Show resolved Hide resolved
Comment on lines +398 to +406
* Dark blue, **beta-** labels track changes which need to be backported into
the beta branches.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't find any reference to stable-* labels for stable backports. Did I miss it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just copy/pasted the document with very minor edits. I don't know much about triage/tagging, so it might be out of date. Feel free to propose additions.

src/contributing.md Outdated Show resolved Hide resolved
src/contributing.md Outdated Show resolved Hide resolved
@mark-i-m mark-i-m merged commit b85f30d into rust-lang:master Jul 2, 2020
@mark-i-m mark-i-m deleted the contributing branch July 2, 2020 03:07
Manishearth added a commit to Manishearth/rust that referenced this pull request Jul 2, 2020
Move contributing.md to rustc-dev-guide and point at getting started

See description on rust-lang/rustc-dev-guide#753
Manishearth added a commit to Manishearth/rust that referenced this pull request Jul 2, 2020
Move contributing.md to rustc-dev-guide and point at getting started

See description on rust-lang/rustc-dev-guide#753
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants