Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
bradzacher merged 1 commit intotypescript-eslint:mainfromJoshuaKGoldberg:docs-discussionsJan 30, 2023
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
1 change: 1 addition & 0 deletions.cspell.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -62,6 +62,7 @@ | ||
"declarators", | ||
"destructure", | ||
"destructured", | ||
"discoverability", | ||
"dprint", | ||
"errored", | ||
"erroring", | ||
28 changes: 28 additions & 0 deletionsdocs/contributing/Discussions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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 deletiondocs/maintenance/ISSUES.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionspackages/website/sidebars/sidebar.base.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.