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

Add tracking issue template for library features. #79698

Merged
merged 1 commit into from
Dec 11, 2020

Conversation

m-ou-se
Copy link
Member

@m-ou-se m-ou-se commented Dec 4, 2020

This adds a issue template for a library tracking issue.

There's already a template for tracking issues, but it's mostly geared towards compiler/language features. A separate template makes it a bit easier to make sure it matches with the process we use for library changes.

Main differences:

  • Added a note about how small library features can be added without RFC, and removed the parts that assume there's an RFC.
  • Merged the 'Steps' and 'History' sections: Library features are often small enough that there's no multiple steps planned ahead of time.
  • Removed the section about avoiding large discussions and opening separate issues for problems with the feature. Library features are usually focussed enough that the discussion about a feature is best kept together in the tracking issue.
  • Removed links to the rustc-dev-guide, which are specific to changes in the compiler and language.

@m-ou-se m-ou-se added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Dec 4, 2020
@m-ou-se m-ou-se requested a review from KodrAus December 4, 2020 11:20
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 4, 2020
@m-ou-se
Copy link
Member Author

m-ou-se commented Dec 4, 2020

cc @rust-lang/libs

@jyn514 jyn514 added the A-meta Area: Issues & PRs about the rust-lang/rust repository itself label Dec 4, 2020
@jyn514
Copy link
Member

jyn514 commented Dec 4, 2020

Removed links to the rustc-dev-guide, which are specific to changes in the compiler and language.

Are you interested in instead adding info about this to the dev-guide? I'd love to add it, it's just a little scattered right now. rust-lang/rustc-dev-guide#932

@m-ou-se
Copy link
Member Author

m-ou-se commented Dec 4, 2020

Are you interested in instead adding info about this to the dev-guide?

@jyn514 Yes, definitely. Some time Soon:tm:.

Copy link
Contributor

@KodrAus KodrAus left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @m-ou-se!

I think it might be worth adding a section for Public API so that we always include the API surface area that a feature covers. It might fall out of date, but I think is still worthwhile for context. What do you think?

.github/ISSUE_TEMPLATE/library_tracking_issue.md Outdated Show resolved Hide resolved
@m-ou-se
Copy link
Member Author

m-ou-se commented Dec 9, 2020

Yeah, that's more or less what I meant with:

Include a description of the feature or a summary of the new API.

I didn't ask for a full copy of the public API, because I don't think I've ever seen a tracking issue that had that where it wasn't outdated. As soon as a feature is part of nightly, I suppose the online docs would be the best reference.

@m-ou-se
Copy link
Member Author

m-ou-se commented Dec 9, 2020

Feel free to push any changes/additions to this branch. (This is only a PR because this file needs to be in this repository, otherwise it'd just be some hackmd everyone can edit.)

@KodrAus
Copy link
Contributor

KodrAus commented Dec 10, 2020

Yeh, that's true. The online docs are helpful too, but you also kind of have to know what you're looking for since you can't search them by feature name. I ended up bootstrapping a little tool in our Libs repo to try make it easier to find the unstable API for a given feature, so maybe that would make it easier for us to either keep a summary up-to-date or to just look at the scope of a given feature on-demand.

@jyn514
Copy link
Member

jyn514 commented Dec 10, 2020

Yeh, that's true. The online docs are helpful too, but you also kind of have to know what you're looking for since you can't search them by feature name. I ended up bootstrapping a little tool in our Libs repo to try make it easier to find the unstable API for a given feature, so maybe that would make it easier for us to either keep a summary up-to-date or to just look at the scope of a given feature on-demand.

@KodrAus would it help to add doc(alias) with the feature name so it shows up in search? Then you have the best of both worlds: both easy to find and up to date.

@m-ou-se
Copy link
Member Author

m-ou-se commented Dec 10, 2020

@KodrAus I added a 'Public API' section. If you have any suggestions, feel free to just push them directly. (Or if you don't have time, we can also just merge this for now and improve things later.)

Nice tool you made, by the way. :)

Copy link
Contributor

@KodrAus KodrAus left a comment

Choose a reason for hiding this comment

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

This looks good to me!

Thanks @m-ou-se

@KodrAus
Copy link
Contributor

KodrAus commented Dec 10, 2020

@jyn514 Oh I’m not familiar with doc(alias) so will go check it out!

@KodrAus
Copy link
Contributor

KodrAus commented Dec 10, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Dec 10, 2020

📌 Commit f7306b1 has been approved by KodrAus

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 10, 2020
@jyn514
Copy link
Member

jyn514 commented Dec 10, 2020

Yeh, that's true. The online docs are helpful too, but you also kind of have to know what you're looking for since you can't search them by feature name. I ended up bootstrapping a little tool in our Libs repo to try make it easier to find the unstable API for a given feature, so maybe that would make it easier for us to either keep a summary up-to-date or to just look at the scope of a given feature on-demand.

@KodrAus would it help to add doc(alias) with the feature name so it shows up in search? Then you have the best of both worlds: both easy to find and up to date.

Actually this should probably go the other way - have rustdoc automatically add a search alias for the feature name when you add #[unstable (feature = x)] (and maybe stable too but that seems more questionable).

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Dec 10, 2020
…e, r=KodrAus

Add tracking issue template for library features.

This adds a issue template for a library tracking issue.

There's already a template for tracking issues, but it's mostly geared towards compiler/language features. A separate template makes it a bit easier to make sure it matches with the process we use for library changes.

Main differences:
- Added a note about how small library features can be added without RFC, and removed the parts that assume there's an RFC.
- Merged the 'Steps' and 'History' sections: Library features are often small enough that there's no multiple steps planned ahead of time.
- Removed the section about avoiding large discussions and opening separate issues for problems with the feature. Library features are usually focussed enough that the discussion about a feature is best kept together in the tracking issue.
- Removed links to the rustc-dev-guide, which are specific to changes in the compiler and language.
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 11, 2020
Rollup of 11 pull requests

Successful merges:

 - rust-lang#77027 (Improve documentation for `std::{f32,f64}::mul_add`)
 - rust-lang#79375 (Make the kernel_copy tests more robust/concurrent.)
 - rust-lang#79639 (Add long explanation for E0212)
 - rust-lang#79698 (Add tracking issue template for library features.)
 - rust-lang#79809 (Dogfood `str_split_once()`)
 - rust-lang#79851 (Clarify the 'default is only allowed on...' error)
 - rust-lang#79858 (Update const-fn doc in unstable-book)
 - rust-lang#79860 (Clarify that String::split_at takes a byte index.)
 - rust-lang#79871 (Fix small typo in `wrapping_shl` documentation)
 - rust-lang#79896 (Make search results tab and help button focusable with keyboard)
 - rust-lang#79917 (Use Symbol for inline asm register class names)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 8b9a59c into rust-lang:master Dec 11, 2020
@rustbot rustbot added this to the 1.50.0 milestone Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: Issues & PRs about the rust-lang/rust repository itself S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants