-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Add an issue template for future-incompatible lints #140904
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
base: master
Are you sure you want to change the base?
Conversation
rustbot has assigned @Mark-Simulacrum. Use |
Also check for any `A-` labels to add. | ||
--> | ||
|
||
This is the **tracking issue** for the `YOUR_LINT_NAME_HERE` future-compatibility warning and other related errors. The goal of this page is describe why this change was made and how you can fix code that is affected by it. It also provides a place to ask questions or register a complaint if you feel the change should not be made. For more information on the policy around future-compatibility warnings, see our [breaking change policy guidelines][guidelines]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussion: usually other tracking issues avoid encouraging detailed discussions on the tracking issue because it quickly becomes impossible to manage and usually there's no one around to actively summarize (esp. when it starts to collapse comments and backlinks extending the page height). Maybe instead have a section like "### Discussions and concerns
" where dedicated issues for specific topics are backlinked to this main tracking issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, there are tradeoffs here. To be clear, this is from the RFC.
I agree that regular tracking issues are not well suited for discussion. However, I think a large part of these FCW issues is to solicit input from users. I can appreciate having a relatively lightweight means for people to leave comments about their concerns or questions. Unlike regular tracking issues, I suspect users won't be subscribing to the issue to receive updates since I doubt anyone will be looking forward to them closing (they aren't introducing new features people are excited about). And thus I'm not too concerned about it being spammy. I think if the issue does a good job of explaining the FCW and what is happening and why, then there should be fewer reasons for people to ask questions.
But if the team wants to change the process, I can update the text.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is fine. If we find that it becomes too spammy in practice, we can always:
- Change this template
- Lock the original tracking issue, and explicitly fork off separate discussion issues.
a7e2e69
to
f6aeef3
Compare
I pushed an update, I realized I can now edit the rustc-dev-guide at the same time. |
This adds a GitHub issue template for future-incompatible lints. Most of the existing tracking issues have been using different formats with different information, and I think it would be helpful to make them a little more consistent and to ensure that sufficient information is provided.
Some comments on my choices: