From 6049197cf24ce077b7107ca99331c4cfe2fbbb3d Mon Sep 17 00:00:00 2001 From: Joseph Savona Date: Wed, 31 Jan 2024 11:54:02 -0500 Subject: [PATCH 1/6] Add template for applying to add a new React framework --- .../add-recommended-framework.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/add-recommended-framework.md diff --git a/.github/ISSUE_TEMPLATE/add-recommended-framework.md b/.github/ISSUE_TEMPLATE/add-recommended-framework.md new file mode 100644 index 00000000000..4b0597c4233 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/add-recommended-framework.md @@ -0,0 +1,25 @@ +--- +name: Add recommended framework +about: Apply to add a framework to react.dev +title: Add to production-grade frameworks list +labels: '' +assignees: '' + +--- + +Please use this template to apply to include a new framework on our list of [Production-grade React frameworks](https://react.dev/learn/start-a-new-react-project#production-grade-react-frameworks). + +Our goal with the “Production-grade React frameworks” list is to set developers up for success with React, with frameworks that provide a great developer experience and make it easy to build a great user experience. While we understand that many frameworks may want to be featured, this page is not a place to advertise every possible React framework. + +To be included, frameworks must meet the following criteria: + +- **Easy onboarding experience**. The framework must be straightforward to install and configure to use with React. Frameworks may also support other view libraries as long as they meet the other requirements on this list. +- **Well-documented**. The framework must have documentation for common use-cases, troubleshooting, how to deploy apps, etc. +- **Ecosystem compatibility**. The framework must support using the full range of libraries and tools in the React ecosystem. +- **Great developer experience**. The framework must allow developers to be productive, and support tools such as React Developer Tools and Fast Refresh. +- **Great user experience**. The framework must help developers create high quality user experiences by solving common use-cases. Specifically, the framework must provide built-in support for routing and data-fetching in a way that avoids client/server waterfalls by default. +- **Active Community**. The framework must have a sufficiently large/active community in order to provide help and support to users. +- **Compatible with our future vision for React**. React evolves over time, and frameworks that do not align with React’s direction risk isolating their users from the main React ecosystem over time. To be included on this page we must feel confident that the framework is setting its user up for success with React over time. +- **Self-hosting option**. The framework must support an option to self-host applications without losing access to the baseline features included on this list. +- **Well maintained**. The framework must be actively maintained. +- **Free & open-source**. From c06fbf70b76fef01c5edae2564ccbcd398737a99 Mon Sep 17 00:00:00 2001 From: Joe Savona Date: Wed, 31 Jan 2024 12:03:41 -0500 Subject: [PATCH 2/6] update --- .github/ISSUE_TEMPLATE/0-bug.md | 10 ++++++++++ ...ded-framework.md => 1-add-recommended-framework.md} | 5 +++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 3 files changed, 16 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/0-bug.md rename .github/ISSUE_TEMPLATE/{add-recommended-framework.md => 1-add-recommended-framework.md} (92%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/0-bug.md b/.github/ISSUE_TEMPLATE/0-bug.md new file mode 100644 index 00000000000..93e3649c91c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0-bug.md @@ -0,0 +1,10 @@ +--- +name: Report a bug, typo, or content issue +about: Use this for general issues with the react.dev website +title: '' +labels: '' +assignees: '' + +--- + +Please describe the issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/add-recommended-framework.md b/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md similarity index 92% rename from .github/ISSUE_TEMPLATE/add-recommended-framework.md rename to .github/ISSUE_TEMPLATE/1-add-recommended-framework.md index 4b0597c4233..ceb07d76063 100644 --- a/.github/ISSUE_TEMPLATE/add-recommended-framework.md +++ b/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md @@ -23,3 +23,8 @@ To be included, frameworks must meet the following criteria: - **Self-hosting option**. The framework must support an option to self-host applications without losing access to the baseline features included on this list. - **Well maintained**. The framework must be actively maintained. - **Free & open-source**. + +To apply, please provide: +* The name of your framework +* A link to the framework's main code repository +* A bullted list describing how the framework meets each of the above criteria \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..a49eab2f6b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file From 9baa180de6cd68556f9d980d1059ae7f54742cf6 Mon Sep 17 00:00:00 2001 From: Joe Savona Date: Wed, 31 Jan 2024 12:08:12 -0500 Subject: [PATCH 3/6] grammar --- .github/ISSUE_TEMPLATE/1-add-recommended-framework.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md b/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md index ceb07d76063..761cafbc697 100644 --- a/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md +++ b/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md @@ -19,7 +19,7 @@ To be included, frameworks must meet the following criteria: - **Great developer experience**. The framework must allow developers to be productive, and support tools such as React Developer Tools and Fast Refresh. - **Great user experience**. The framework must help developers create high quality user experiences by solving common use-cases. Specifically, the framework must provide built-in support for routing and data-fetching in a way that avoids client/server waterfalls by default. - **Active Community**. The framework must have a sufficiently large/active community in order to provide help and support to users. -- **Compatible with our future vision for React**. React evolves over time, and frameworks that do not align with React’s direction risk isolating their users from the main React ecosystem over time. To be included on this page we must feel confident that the framework is setting its user up for success with React over time. +- **Compatible with our future vision for React**. React evolves over time, and frameworks that do not align with React’s direction risk isolating their users from the main React ecosystem over time. To be included on this page we must feel confident that the framework is setting its users up for success with React over time. - **Self-hosting option**. The framework must support an option to self-host applications without losing access to the baseline features included on this list. - **Well maintained**. The framework must be actively maintained. - **Free & open-source**. From 8f9dea4b2ef36f936eca705b539cce37795677c1 Mon Sep 17 00:00:00 2001 From: Ricky Hanlon Date: Wed, 31 Jan 2024 23:39:18 -0500 Subject: [PATCH 4/6] Add form templates --- .github/ISSUE_TEMPLATE/0-bug.md | 10 -- .github/ISSUE_TEMPLATE/0-bug.yml | 34 +++++ .../1-add-recommended-framework.md | 30 ----- .github/ISSUE_TEMPLATE/1-typo.yml | 34 +++++ .github/ISSUE_TEMPLATE/2-suggestion.yml | 34 +++++ .github/ISSUE_TEMPLATE/3-framework.yml | 116 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +- 7 files changed, 225 insertions(+), 41 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/0-bug.md create mode 100644 .github/ISSUE_TEMPLATE/0-bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/1-add-recommended-framework.md create mode 100644 .github/ISSUE_TEMPLATE/1-typo.yml create mode 100644 .github/ISSUE_TEMPLATE/2-suggestion.yml create mode 100644 .github/ISSUE_TEMPLATE/3-framework.yml diff --git a/.github/ISSUE_TEMPLATE/0-bug.md b/.github/ISSUE_TEMPLATE/0-bug.md deleted file mode 100644 index 93e3649c91c..00000000000 --- a/.github/ISSUE_TEMPLATE/0-bug.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Report a bug, typo, or content issue -about: Use this for general issues with the react.dev website -title: '' -labels: '' -assignees: '' - ---- - -Please describe the issue. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/0-bug.yml b/.github/ISSUE_TEMPLATE/0-bug.yml new file mode 100644 index 00000000000..56d2e8540f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0-bug.yml @@ -0,0 +1,34 @@ +name: "🐛 Report a bug" +description: "Report a problem on the website." +title: "[Bug]: " +labels: ["bug: unconfirmed"] +body: + - type: textarea + attributes: + label: Summary + description: | + A clear and concise summary of what the bug is. + placeholder: | + Example bug report: + When I click the "Submit" button on "Feedback", nothing happens. + validations: + required: true + - type: input + attributes: + label: Page + description: | + What page(s) did you encounter this bug on? + placeholder: | + https://react.dev/ + validations: + required: true + - type: textarea + attributes: + label: Details + description: | + Please provide any additional details about the bug. + placeholder: | + Example details: + The "Submit" button is unresponsive. I've tried refreshing the page and using a different browser, but the issue persists. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md b/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md deleted file mode 100644 index 761cafbc697..00000000000 --- a/.github/ISSUE_TEMPLATE/1-add-recommended-framework.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Add recommended framework -about: Apply to add a framework to react.dev -title: Add to production-grade frameworks list -labels: '' -assignees: '' - ---- - -Please use this template to apply to include a new framework on our list of [Production-grade React frameworks](https://react.dev/learn/start-a-new-react-project#production-grade-react-frameworks). - -Our goal with the “Production-grade React frameworks” list is to set developers up for success with React, with frameworks that provide a great developer experience and make it easy to build a great user experience. While we understand that many frameworks may want to be featured, this page is not a place to advertise every possible React framework. - -To be included, frameworks must meet the following criteria: - -- **Easy onboarding experience**. The framework must be straightforward to install and configure to use with React. Frameworks may also support other view libraries as long as they meet the other requirements on this list. -- **Well-documented**. The framework must have documentation for common use-cases, troubleshooting, how to deploy apps, etc. -- **Ecosystem compatibility**. The framework must support using the full range of libraries and tools in the React ecosystem. -- **Great developer experience**. The framework must allow developers to be productive, and support tools such as React Developer Tools and Fast Refresh. -- **Great user experience**. The framework must help developers create high quality user experiences by solving common use-cases. Specifically, the framework must provide built-in support for routing and data-fetching in a way that avoids client/server waterfalls by default. -- **Active Community**. The framework must have a sufficiently large/active community in order to provide help and support to users. -- **Compatible with our future vision for React**. React evolves over time, and frameworks that do not align with React’s direction risk isolating their users from the main React ecosystem over time. To be included on this page we must feel confident that the framework is setting its users up for success with React over time. -- **Self-hosting option**. The framework must support an option to self-host applications without losing access to the baseline features included on this list. -- **Well maintained**. The framework must be actively maintained. -- **Free & open-source**. - -To apply, please provide: -* The name of your framework -* A link to the framework's main code repository -* A bullted list describing how the framework meets each of the above criteria \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/1-typo.yml b/.github/ISSUE_TEMPLATE/1-typo.yml new file mode 100644 index 00000000000..c86557a1160 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-typo.yml @@ -0,0 +1,34 @@ +name: "🤦 Typo or mistake" +description: "Report a typo or mistake in the docs." +title: "[Typo]: " +labels: ["type: typos"] +body: + - type: textarea + attributes: + label: Summary + description: | + A clear and concise summary of what the mistake is. + placeholder: | + Example: + The code example on the "useReducer" page includes an unused variable `nextId`. + validations: + required: true + - type: input + attributes: + label: Page + description: | + What page is the typo on? + placeholder: | + https://react.dev/ + validations: + required: true + - type: textarea + attributes: + label: Details + description: | + Please provide a explanation for why this is a mistake. + placeholder: | + Example mistake: + In the "useReducer" section of the "API Reference" page, the code example under "Writing a reducer function" includes an unused variable `nextId` that should be removed. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-suggestion.yml b/.github/ISSUE_TEMPLATE/2-suggestion.yml new file mode 100644 index 00000000000..ac0b480fe9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-suggestion.yml @@ -0,0 +1,34 @@ +name: "💡 Suggestions" +description: "Suggest a new page, section, or edit for an existing page." +title: "[Suggestion]: " +labels: ["type: documentation"] +body: + - type: textarea + attributes: + label: Summary + description: | + A clear and concise summary of what we should add. + placeholder: | + Example: + Add a new page for how to use React with TypeScript. + validations: + required: true + - type: input + attributes: + label: Page + description: | + What page is this about? + placeholder: | + https://react.dev/ + validations: + required: false + - type: textarea + attributes: + label: Details + description: | + Please provide a explanation for what you're suggesting. + placeholder: | + Example: + I think it would be helpful to have a page that explains how to use React with TypeScript. This could include a basic example of a component written in TypeScript, and a link to the TypeScript documentation. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3-framework.yml b/.github/ISSUE_TEMPLATE/3-framework.yml new file mode 100644 index 00000000000..a47295e1e87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-framework.yml @@ -0,0 +1,116 @@ +name: "📄 Suggest new framework" +description: "I am a framework author applying to be included as a recommended framework." +title: "[Framework]: " +labels: ["type: framework"] +body: + - type: markdown + attributes: + value: | + ## Apply to be included as a recommended React framework + + _This form is for framework authors to apply to be included as a recommended [React framework](https://react.dev/learn/start-a-new-react-project). If you are not a framework author, please contact the authors before submitting._ + + Our goal when recommending a framework is to start developers with a React project that solves common problems like code splitting, data fetching, routing, and HTML generation without any extra work later. We believe this will allow users to get started quickly with React, and scale their app to production. + + While we understand that many frameworks may want to be featured, this page is not a place to advertise every possible React framework or all frameworks that you can add React to. There are many great frameworks that offer support for React that are not listed in our guides. The frameworks we recommend have invested significantly in the React ecosystem, and collaborated with the React team to be compatible with our [full-stack React architecture vision](https://react.dev/learn/start-a-new-react-project#which-features-make-up-the-react-teams-full-stack-architecture-vision). + + To be included, frameworks must meet the following criteria: + + - **Free & open-source**: must be open source and free to use. + - **Well maintained**. must be actively maintained, providing bug fixes and improvements. + - **Active community**: must have a sufficiently large and active community to support users. + - **Clear onboarding**: must have clear install steps to install the React version of the framework. + - **Ecosystem compatibility**: must support using the full range of libraries and tools in the React ecosystem. + - **Self-hosting option**: must support an option to self-host applications without losing access to features. + - **Developer experience**. must allow developers to be productive by supporting features like Fast Refresh. + - **User experience**. must provide built-in support for common problems like routing and data-fetching. + - **Compatible with our future vision for React**. React evolves over time, and frameworks that do not align with React’s direction risk isolating their users from the main React ecosystem over time. To be included on this page we must feel confident that the framework is setting its users up for success with React over time. + + Please note, we have reviewed most of the popular frameworks available today, so it is unlikely we have not considered your framework already. But if you think we missed something, please complete the application below. + - type: input + attributes: + label: Name + description: | + What is the name of your framework? + validations: + required: true + - type: input + attributes: + label: Homepage + description: | + What is the URL of your homepage? + validations: + required: true + - type: input + attributes: + label: Install instructions + description: | + What is the URL of your getting started guide? + validations: + required: true + - type: dropdown + attributes: + label: Is your framework open source? + description: | + We only recommend free and open source frameworks. + options: + - 'No' + - 'Yes' + validations: + required: true + - type: textarea + attributes: + label: Well maintained + description: | + Please describe how your framework is actively maintained. Include recent releases, bug fixes, and improvements as examples. + validations: + required: true + - type: textarea + attributes: + label: Active community + description: | + Please describe your community. Include the size of your community, and links to community resources. + validations: + required: true + - type: textarea + attributes: + label: Clear onboarding + description: | + Please describe how a user can install your framework with React. Include links to any relevant documentation. + validations: + required: true + - type: textarea + attributes: + label: Ecosystem compatibility + description: | + Please describe any limitations your framework has with the React ecosystem. Include any libraries or tools that are not compatible with your framework. + validations: + required: true + - type: textarea + attributes: + label: Self-hosting option + description: | + Please describe how your framework supports self-hosting. Include any limitations to features when self-hosting. Also include whether you require a server to deploy your framework. + validations: + required: true + - type: textarea + attributes: + label: Developer Experience + description: | + Please describe how your framework provides a great developer experience. Include any limitations to React features like React DevTools, Chrome DevTools, and Fast Refresh. + validations: + required: true + - type: textarea + attributes: + label: User Experience + description: | + Please describe how your framework helps developers create high quality user experiences by solving common use-cases. Include specifics for how your framework offers built-in support for code-splitting, routing, HTML generation, and data-fetching in a way that avoids client/server waterfalls by default. Include details on how you offer features such as SSG and SSR. + validations: + required: true + - type: textarea + attributes: + label: Compatible with our future vision for React + description: | + Please describe how your framework aligns with our future vision for React. Include how your framework will evolve with React over time, and your plans to support future React features like React Server Components. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a49eab2f6b9..6e99e2d8d7e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,7 @@ -blank_issues_enabled: true \ No newline at end of file +contact_links: + - name: 📃 Bugs in React + url: https://github.com/facebook/react.dev/issues/new + about: This issue tracker is not for bugs in React. Please file React issues here. + - name: 🤔 Questions and Help + url: https://reactjs.org/community/support.html + about: This issue tracker is not for support questions. Please refer to the React community's help and discussion forums. From 1d51896cd7117bf083ed5d7d6fce3fb90c2bcf96 Mon Sep 17 00:00:00 2001 From: Ricky Date: Thu, 1 Feb 2024 10:59:30 -0500 Subject: [PATCH 5/6] Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Strek --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6e99e2d8d7e..c39a0767dca 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ contact_links: - name: 📃 Bugs in React - url: https://github.com/facebook/react.dev/issues/new + url: https://github.com/reactjs/react.dev/issues/new about: This issue tracker is not for bugs in React. Please file React issues here. - name: 🤔 Questions and Help url: https://reactjs.org/community/support.html From 918976a981bc3a010d72b4514beeb06c65b212c1 Mon Sep 17 00:00:00 2001 From: Ricky Hanlon Date: Thu, 1 Feb 2024 13:37:57 -0500 Subject: [PATCH 6/6] correct link --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c39a0767dca..63e310e0bad 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ contact_links: - name: 📃 Bugs in React - url: https://github.com/reactjs/react.dev/issues/new + url: https://github.com/facebook/react/issues/new/choose about: This issue tracker is not for bugs in React. Please file React issues here. - name: 🤔 Questions and Help url: https://reactjs.org/community/support.html