Skip to content

Commit 8b9a59c

Browse files
authored
Rollup merge of #79698 - m-ou-se:libs-tracking-issue-template, 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.
2 parents f3a3fc9 + f7306b1 commit 8b9a59c

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: Library Tracking Issue
3+
about: A tracking issue for an unstable library feature.
4+
title: Tracking Issue for XXX
5+
labels: C-tracking-issue T-libs
6+
---
7+
<!--
8+
Thank you for creating a tracking issue!
9+
10+
Tracking issues are for tracking a feature from implementation to stabilization.
11+
12+
Make sure to include the relevant RFC for the feature if it has one.
13+
14+
If the new feature is small, it may be fine to skip the RFC process. In that
15+
case, you can use use `issue = "none"` in your initial implementation PR. The
16+
reviewer will ask you to open a tracking issue if they agree your feature can be
17+
added without an RFC.
18+
-->
19+
20+
Feature gate: `#![feature(...)]`
21+
22+
This is a tracking issue for ...
23+
24+
<!--
25+
Include a short description of the feature.
26+
-->
27+
28+
### Public API
29+
30+
<!--
31+
For most library features, it'd be useful to include a summarized version of the public API.
32+
(E.g. just the public function signatures without their doc comments or implementation.)
33+
-->
34+
35+
```rust
36+
...
37+
```
38+
39+
### Steps / History
40+
41+
<!--
42+
In the simplest case, this is a PR implementing the feature followed by a PR
43+
that stabilises the feature. However it's not uncommon for the feature to be
44+
changed before stabilization. For larger features, the implementation could be
45+
split up in multiple steps.
46+
-->
47+
48+
- [ ] Implementation: ...
49+
- [ ] Stabilization PR
50+
51+
### Unresolved Questions
52+
53+
<!--
54+
Include any open questions that need to be answered before the feature can be
55+
stabilised. If multiple (unrelated) big questions come up, it can be a good idea
56+
to open a separate issue for each, to make it easier to keep track of the
57+
discussions.
58+
59+
It's useful to link any relevant discussions and conclusions (whether on GitHub,
60+
Zulip, or the internals forum) here.
61+
-->
62+
63+
- None yet.

0 commit comments

Comments
 (0)