Skip to content

Commit 7848b72

Browse files
Add the RFC process to CONTRIBUTING.md and issue template (lit#3208)
1 parent 42b1ae8 commit 7848b72

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.github/ISSUE_TEMPLATE/feature-request.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@ name: 🦄 Feature Request
22
description: Request a new feature for Lit or a Lit library/tool.
33

44
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Should this be an RFC?
8+
description: |
9+
Lit uses the [Lit RFC Process](https://github.com/lit/rfcs) to propose and discuss substantial chnages. Significant changes should not be opened as feature request issues here, but follow the RFC process at https://github.com/lit/rfcs.
10+
options:
11+
- label: This is not a substantial change
12+
required: true
513
- type: dropdown
614
id: affected
715
validations:

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,17 @@ Please search though open and closed issues to see if a similar issue already ex
1616

1717
Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! Please feel free to re-open issues we've closed if there's something we've missed and they still need to be addressed.
1818

19+
## RFCs
20+
21+
The Lit project handles "significant" changes and feature requests via our [RFC (Request for Comment) Process](https://github.com/lit/rfcs).
22+
23+
Medium-to-large feature requests should be done via RFC, and feature request issues may be closed after asking that they be submitted as an RFC. If you're wondering whether there's interest in an idea before creating an RFC, file an [RRFC issue](https://github.com/lit/rfcs#before-opening-an-rfc) in https://github.com/lit/rfcs to discuss it.
24+
1925
## Pull Requests
2026

2127
Pull requests are greatly appreciated! To ensure a smooth review process, please follow these steps:
2228

23-
1. Make sure there's an open issue that the PR addresses. Add "Fixes #(issue number)" to the PR description.
29+
1. Make sure there's an open issue or RFC that the PR addresses. If there's an issue, add "Fixes #(issue number)" to the PR description.
2430
2. Please discuss the general shape of the change ahead of time. This can save much time for reviewers and submitters alike. Many times there may be existing ideas on how to handle an issue that are not fully written out, and asking about it will bring out more details.
2531
3. All PRs that change behavior or fix bugs should have new or updated tests.
2632
4. Try to create a set of descriptive commits that each do one focused change. Avoid commits like "oops", and prefer commits like "Added method foo to Bar".

0 commit comments

Comments
 (0)