Skip to content

Highfive on libc provides incorrect contributing information #39704

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

Closed
binarycrusader opened this issue Feb 9, 2017 · 8 comments
Closed

Highfive on libc provides incorrect contributing information #39704

binarycrusader opened this issue Feb 9, 2017 · 8 comments
Labels
C-bug Category: This is a bug. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue.

Comments

@binarycrusader
Copy link
Contributor

As a new contributor, I was surprised to discover that running tidy via 'x.py src/tools/tidy' at the top-level was not sufficient to check changes in submodules.

Please consider adding a recursive option that understands the rules of each submodule and runs the appropriate style check.

If this already exists somehow, my apologies.

@binarycrusader binarycrusader changed the title consider making tidy recurse or adding a recursive option consider making tidy recursive / update contributing info Feb 9, 2017
@binarycrusader
Copy link
Contributor Author

Also, please consider updating the "Pull Requests" section in the contributing information to make it clear that each submodule of rust (for reasons unclear to me) has its own contribution process.

@alexcrichton
Copy link
Member

FWIW I don't think there's much to do here for this repo specifically, we don't actually want to force our own style guidelines on all other repos we use. The motivation for this report, however, I think is quite relevant! Namely we should probably tweak the contributing guidelines to at least mention that they're targeted at rust-lang/rust. Otherwise because rust-highfive is running on a bunch of other repos it may be confusing with the same message across all of them.

@nrc do you know if it'd be possible for rust-highfive to have a tweaked message across repositories?

@binarycrusader
Copy link
Contributor Author

I think, at a minimum, it'd be helpful to make the relationship between rust-lang/rust and the other submodules clearer. From a person new to contributing to rust, "it's all one project". It's very confusing when you discover that they're not. Briefly explaining that relationship and mentioning that each has its own contribution process would help immensely, as would tweaking the message from the bot. Thanks for your kind consideration.

@nrc
Copy link
Member

nrc commented Feb 10, 2017

do you know if it'd be possible for rust-highfive to have a tweaked message across repositories?

This would be very easy to implement

@alexcrichton
Copy link
Member

@binarycrusader yeah definitely!

@nrc I believe all the relevant configuration is in your highfive repo right? And it looks like the message specifically for new PRs would be in newpr.py?

@nrc
Copy link
Member

nrc commented Feb 14, 2017

@alexcrichton yes and yes

@Mark-Simulacrum
Copy link
Member

I believe we should add a dedicated contributing option to the config for libc, here. I'm uncertain how the deploy process for highfive works today though.

@Mark-Simulacrum Mark-Simulacrum changed the title consider making tidy recursive / update contributing info Highfive on libc provides incorrect contributing information May 23, 2017
@Mark-Simulacrum Mark-Simulacrum added T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. and removed A-infrastructure labels Jun 25, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-bug Category: This is a bug. label Jul 27, 2017
@JohnTitor
Copy link
Member

Triage: highfive on libc now displays the contributing.md on the repo as expected (e.g. rust-lang/libc#1974 (comment)).
Also, the rustc-dev-guide, which is the contributing guide of rust-lang/rust, has some mentions about submodules e.g. https://rustc-dev-guide.rust-lang.org/contributing.html?highlight=submodule#external-dependencies-submodules
So I'm going to close this issue. If you have any thoughts about submodules, feel free to open a new issue on the rustc-dev-guide repo. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants