Skip to content

docs: added Contributing > Discussions page #6249

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

Merged
merged 1 commit into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
"declarators",
"destructure",
"destructured",
"discoverability",
"dprint",
"errored",
"erroring",
Expand Down
28 changes: 28 additions & 0 deletions docs/contributing/Discussions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
id: discussions
title: Discussions
---

Most proposals in the typescript-eslint repository happen in [GitHub Issues](https://docs.github.com/issues).
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).

We have [GitHub Discussions](https://docs.github.com/discussions) enabled to enable three kinds of deeper, threaded conversations:

- **Community Feedback**: Questions from the maintainer team that should be raised to the broader community
- **RFCs (Requests For Comments)**: Formalized proposals for larger changes that should be discussed before turned into issues
- **Technical Discussions**: Deeper questions about typescript-eslint's architecture and/or APIs

Before filing a Discussion, search the issue tracker for any related conversations.
Link to them in the Discussion, along with a detailed description of what you'd like to discuss.

:::tip
For change proposals that match an [existing issue format](https://github.com/typescript-eslint/typescript-eslint/issues/new/choose), keep to filing issues.
Most don't need to be moved to this separate format.
We can always move an issue to a discussion if it becomes unexpectedly deep.
:::

:::caution
Please don't use Discussions as a support forum.
We don't have the maintainer-budget to handle that.
See [Issues > Questions and Support Requests](./Issues.mdx#questions-and-support-requests).
:::
2 changes: 1 addition & 1 deletion docs/maintenance/ISSUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: issues
title: Issues
---

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

Use your best judgement when triaging issues, and most of all remember to be **kind, friendly, and encouraging** when responding to users.
Many users are new to open source and/or typed linting.
Expand Down
1 change: 1 addition & 0 deletions packages/website/sidebars/sidebar.base.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ module.exports = {
'custom-rules',
{
items: [
'contributing/discussions',
'contributing/issues',
'contributing/local-development',
'contributing/pull-requests',
Expand Down