-
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
Open
ehuss
wants to merge
1
commit into
rust-lang:master
Choose a base branch
from
ehuss:future-incompat-template
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
name: Future Incompatibility Tracking Issue | ||
about: A tracking issue for a future-incompatible lint | ||
title: Tracking Issue for future-incompatibility lint XXX | ||
labels: C-tracking-issue C-future-incompatibility T-compiler A-lints | ||
--- | ||
<!-- | ||
Thank you for creating a future-incompatible tracking issue! 📜 These issues | ||
are for lints that implement a future-incompatible warning. | ||
|
||
Remember to add team labels to the tracking issue. | ||
For something that affects the language, this would be `T-lang`, and for libs | ||
it would be `T-libs-api`. | ||
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]. | ||
|
||
[guidelines]: https://rustc-dev-guide.rust-lang.org/bug-fix-procedure.html | ||
|
||
### What is the warning for? | ||
|
||
*Describe the conditions that trigger the warning.* | ||
|
||
### Why was this change made? | ||
|
||
*Explain why this change was made. If there is additional context, like an MCP, link it here.* | ||
|
||
### Example | ||
|
||
```rust | ||
// Include an example here. | ||
``` | ||
|
||
### Recommendations | ||
|
||
*Give some recommendations on how a user can avoid the lint.* | ||
|
||
### When will this warning become a hard error? | ||
|
||
*If known, describe the future plans. For example, how long you anticipate this being a warning, or if there are other factors that will influence the anticipated closure.* | ||
|
||
### Steps | ||
|
||
- [ ] Implement the lint | ||
- [ ] Raise lint level to deny | ||
- [ ] Make lint report in dependencies | ||
- [ ] Switch to a hard error | ||
|
||
### Implementation history | ||
|
||
<!-- | ||
Include a list of all the PRs that were involved in implementing the lint. | ||
--> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: