Skip to content

Commit e8d2af3

Browse files
docs: added Contributing > Discussions page (#6249)
1 parent 403f2af commit e8d2af3

File tree

4 files changed

+31
-1
lines changed

4 files changed

+31
-1
lines changed

.cspell.json

+1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
"declarators",
6363
"destructure",
6464
"destructured",
65+
"discoverability",
6566
"dprint",
6667
"errored",
6768
"erroring",

docs/contributing/Discussions.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
id: discussions
3+
title: Discussions
4+
---
5+
6+
Most proposals in the typescript-eslint repository happen in [GitHub Issues](https://docs.github.com/issues).
7+
We generally try to keep conversations inside issues for their discoverability and ability to be linked to [GitHub Pull Requests](https://docs.github.com/pull-requests).
8+
9+
We have [GitHub Discussions](https://docs.github.com/discussions) enabled to enable three kinds of deeper, threaded conversations:
10+
11+
- **Community Feedback**: Questions from the maintainer team that should be raised to the broader community
12+
- **RFCs (Requests For Comments)**: Formalized proposals for larger changes that should be discussed before turned into issues
13+
- **Technical Discussions**: Deeper questions about typescript-eslint's architecture and/or APIs
14+
15+
Before filing a Discussion, search the issue tracker for any related conversations.
16+
Link to them in the Discussion, along with a detailed description of what you'd like to discuss.
17+
18+
:::tip
19+
For change proposals that match an [existing issue format](https://github.com/typescript-eslint/typescript-eslint/issues/new/choose), keep to filing issues.
20+
Most don't need to be moved to this separate format.
21+
We can always move an issue to a discussion if it becomes unexpectedly deep.
22+
:::
23+
24+
:::caution
25+
Please don't use Discussions as a support forum.
26+
We don't have the maintainer-budget to handle that.
27+
See [Issues > Questions and Support Requests](./Issues.mdx#questions-and-support-requests).
28+
:::

docs/maintenance/ISSUES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: issues
33
title: Issues
44
---
55

6-
This document serves as a guide for how you might manage issues, also known as issue triaging.
6+
This document serves as a guide for how you might manage our [GitHub Issues](https://docs.github.com/issues), also known as issue triaging.
77

88
Use your best judgement when triaging issues, and most of all remember to be **kind, friendly, and encouraging** when responding to users.
99
Many users are new to open source and/or typed linting.

packages/website/sidebars/sidebar.base.js

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ module.exports = {
3939
'custom-rules',
4040
{
4141
items: [
42+
'contributing/discussions',
4243
'contributing/issues',
4344
'contributing/local-development',
4445
'contributing/pull-requests',

0 commit comments

Comments
 (0)