From 53eba9c2a43f9408ae9319121cc46bcb9b76a6b0 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter Date: Sun, 5 Mar 2023 16:32:02 -0500 Subject: [PATCH 1/7] docs: How eslint is maintained page --- docs/src/maintain/index.md | 4 ++ docs/src/maintain/manage-issues.md | 2 +- docs/src/maintain/manage-releases.md | 2 +- docs/src/maintain/overview.md | 50 +++++++++++++++++++++++ docs/src/maintain/review-pull-requests.md | 2 +- docs/src/maintain/working-groups.md | 2 +- 6 files changed, 58 insertions(+), 4 deletions(-) create mode 100644 docs/src/maintain/overview.md diff --git a/docs/src/maintain/index.md b/docs/src/maintain/index.md index 88d537aa053..eff713e1b4d 100644 --- a/docs/src/maintain/index.md +++ b/docs/src/maintain/index.md @@ -9,6 +9,10 @@ eleventyNavigation: This guide is intended for those who work as part of the ESLint project team. +## [How ESLint is Maintained](overview) + +Explains how ESLint is maintained, including information about team, governance, and funding. + ## [Manage Issues](manage-issues) Describes how to deal with issues when they're opened, when interacting with users, and how to close them effectively. diff --git a/docs/src/maintain/manage-issues.md b/docs/src/maintain/manage-issues.md index 085b1083782..b9b0ff48b22 100644 --- a/docs/src/maintain/manage-issues.md +++ b/docs/src/maintain/manage-issues.md @@ -4,7 +4,7 @@ eleventyNavigation: key: manage issues parent: maintain eslint title: Manage Issues - order: 1 + order: 2 --- diff --git a/docs/src/maintain/manage-releases.md b/docs/src/maintain/manage-releases.md index 10d681a4fd8..b4b4cead92b 100644 --- a/docs/src/maintain/manage-releases.md +++ b/docs/src/maintain/manage-releases.md @@ -4,7 +4,7 @@ eleventyNavigation: key: manage releases parent: maintain eslint title: Manage Releases - order: 3 + order: 4 --- diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md new file mode 100644 index 00000000000..e8359554331 --- /dev/null +++ b/docs/src/maintain/overview.md @@ -0,0 +1,50 @@ +--- +title: How ESLint is Maintained +eleventyNavigation: + key: how eslint is maintained + parent: maintain eslint + title: How ESLint is Maintained + order: 1 + +--- + +This page explains the different roles and structures involved in maintaining ESLint. + +## The ESLint Team + +The ESLint team work together to develop and maintain ESLint. The team consists of several different roles, including: + +* **Technical Steering Committee (TSC)**: Manage releases, review feature requests, and meet regularly to ensure ESLint is properly maintained. +* **Reviewers**: Review and implement new features. +* **Committers**: Review and fix bugs and help triage issues. +* **Website Team**: Focus specifically on [eslint.org](https://eslint.org). +* **Support Team**: Help in Discord and discussions. + +To learn more about the current team members, refer to the [Team](https://eslint.org/team/) page. + +## Organization Structure + +TODO: provide a little more info about what the OpenJS foundation actually does vis-a-vis ESLint. + +ESLint is part of the [OpenJS Foundation](https://openjsf.org/), a nonprofit organization that supports open-source projects and communities in the JavaScript ecosystem. The OpenJS Foundation provides support and resources to help ensure that projects like ESLint can continue to grow and evolve. + +## Funding + +ESLint is funded through several sources, including: + +* [**Open Collective**](https://opencollective.com/eslint): A platform for financing open source projects. +* [**GitHub Sponsors**](https://github.com/sponsors/eslint): A platform for funding open source projects associated with Github. +* [**Tidelift**](https://tidelift.com/subscription/pkg/npm-eslint): A subscription service that lets enterprises manage and fund the open source projects that their organization uses. +* [**Carbon Ads**](https://www.carbonads.net/open-source): Developer-centric advertising provider used on eslint.org. +* [**Stackaid.us**](https://simulation.stackaid.us/github/eslint/eslint): Tool that developers can use to allocate funding to the open source projects they use. + +ESLint uses this funding for the following purposes: + +* Pay team members +* Fund projects +* Pay for services that keep ESLint running (web hosting, software subscriptions, etc.) +* Provide financial support to our dependencies and ecosystem + +## Joining the Maintainer Team + +ESLint is an open-source project, and anyone can contribute to the project. If you're interested in becoming part of the maintainer team, TODO: what to do? diff --git a/docs/src/maintain/review-pull-requests.md b/docs/src/maintain/review-pull-requests.md index 976a7fd1696..d69630b3b51 100644 --- a/docs/src/maintain/review-pull-requests.md +++ b/docs/src/maintain/review-pull-requests.md @@ -4,7 +4,7 @@ eleventyNavigation: key: review pull requests parent: maintain eslint title: Review Pull Requests - order: 2 + order: 3 --- diff --git a/docs/src/maintain/working-groups.md b/docs/src/maintain/working-groups.md index 97d31dfd29f..d1ffca7515e 100644 --- a/docs/src/maintain/working-groups.md +++ b/docs/src/maintain/working-groups.md @@ -4,7 +4,7 @@ eleventyNavigation: key: working groups parent: maintain eslint title: Working Groups - order: 4 + order: 5 --- The ESLint TSC may form working groups to focus on a specific area of the project. From c0cdb70071e105623c68d10de3d4de8225875292 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> Date: Thu, 9 Mar 2023 21:19:27 -0500 Subject: [PATCH 2/7] implement reviewer feedback --- docs/src/maintain/overview.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md index e8359554331..c0a7b76e457 100644 --- a/docs/src/maintain/overview.md +++ b/docs/src/maintain/overview.md @@ -12,21 +12,17 @@ This page explains the different roles and structures involved in maintaining ES ## The ESLint Team -The ESLint team work together to develop and maintain ESLint. The team consists of several different roles, including: - -* **Technical Steering Committee (TSC)**: Manage releases, review feature requests, and meet regularly to ensure ESLint is properly maintained. -* **Reviewers**: Review and implement new features. -* **Committers**: Review and fix bugs and help triage issues. -* **Website Team**: Focus specifically on [eslint.org](https://eslint.org). -* **Support Team**: Help in Discord and discussions. - -To learn more about the current team members, refer to the [Team](https://eslint.org/team/) page. +The ESLint team work together to develop and maintain ESLint. To learn more about the different roles on the ESLint team, refer to [Governance](../contribute/governance). To see the current team members, refer to [Team](https://eslint.org/team/). ## Organization Structure TODO: provide a little more info about what the OpenJS foundation actually does vis-a-vis ESLint. -ESLint is part of the [OpenJS Foundation](https://openjsf.org/), a nonprofit organization that supports open-source projects and communities in the JavaScript ecosystem. The OpenJS Foundation provides support and resources to help ensure that projects like ESLint can continue to grow and evolve. +ESLint is part of the [OpenJS Foundation](https://openjsf.org/), a nonprofit organization that supports open-source projects and communities in the JavaScript ecosystem. + +The OpenJS Foundation provides legal infrastructure for JavaScript projects like ESLint. It is the owner of the intellectual property related to ESLint, including copyrights and trademarks, and ensures the independence of the project. They are also a resource for ESLint if we need legal advice or representation. + +The OpenJS Foundation does not participate in the day-to-day functioning of ESLint. ## Funding @@ -47,4 +43,4 @@ ESLint uses this funding for the following purposes: ## Joining the Maintainer Team -ESLint is an open-source project, and anyone can contribute to the project. If you're interested in becoming part of the maintainer team, TODO: what to do? +ESLint is an open-source project, and anyone can contribute to the project. If you're interested in becoming part of the maintainer team, stop by our Discord and introduce yourself. From 694fb67d31fdb3473123c3fe935a81c57d183c37 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter Date: Thu, 9 Mar 2023 21:23:40 -0500 Subject: [PATCH 3/7] remove trailing space --- docs/src/maintain/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md index c0a7b76e457..c0eaf370b10 100644 --- a/docs/src/maintain/overview.md +++ b/docs/src/maintain/overview.md @@ -22,7 +22,7 @@ ESLint is part of the [OpenJS Foundation](https://openjsf.org/), a nonprofit org The OpenJS Foundation provides legal infrastructure for JavaScript projects like ESLint. It is the owner of the intellectual property related to ESLint, including copyrights and trademarks, and ensures the independence of the project. They are also a resource for ESLint if we need legal advice or representation. -The OpenJS Foundation does not participate in the day-to-day functioning of ESLint. +The OpenJS Foundation does not participate in the day-to-day functioning of ESLint. ## Funding From 9ac04375b9a74e3a86133f02382d5342e5f45aa9 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter Date: Thu, 9 Mar 2023 21:26:08 -0500 Subject: [PATCH 4/7] remove todo --- docs/src/maintain/overview.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md index c0eaf370b10..ee7a064baf6 100644 --- a/docs/src/maintain/overview.md +++ b/docs/src/maintain/overview.md @@ -16,8 +16,6 @@ The ESLint team work together to develop and maintain ESLint. To learn more abou ## Organization Structure -TODO: provide a little more info about what the OpenJS foundation actually does vis-a-vis ESLint. - ESLint is part of the [OpenJS Foundation](https://openjsf.org/), a nonprofit organization that supports open-source projects and communities in the JavaScript ecosystem. The OpenJS Foundation provides legal infrastructure for JavaScript projects like ESLint. It is the owner of the intellectual property related to ESLint, including copyrights and trademarks, and ensures the independence of the project. They are also a resource for ESLint if we need legal advice or representation. From 3e867869fbbcfd6adff3cb1976582342147268e1 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> Date: Sat, 11 Mar 2023 15:04:01 -0500 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Nitin Kumar Co-authored-by: Nicholas C. Zakas --- docs/src/maintain/overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md index ee7a064baf6..2fd22c6b51d 100644 --- a/docs/src/maintain/overview.md +++ b/docs/src/maintain/overview.md @@ -12,7 +12,7 @@ This page explains the different roles and structures involved in maintaining ES ## The ESLint Team -The ESLint team work together to develop and maintain ESLint. To learn more about the different roles on the ESLint team, refer to [Governance](../contribute/governance). To see the current team members, refer to [Team](https://eslint.org/team/). +The ESLint team works together to develop and maintain ESLint. To learn more about the different roles on the ESLint team, refer to [Governance](../contribute/governance). To see the current team members, refer to [Team](https://eslint.org/team/). ## Organization Structure @@ -34,11 +34,11 @@ ESLint is funded through several sources, including: ESLint uses this funding for the following purposes: -* Pay team members +* Pay team members and contractors * Fund projects * Pay for services that keep ESLint running (web hosting, software subscriptions, etc.) * Provide financial support to our dependencies and ecosystem ## Joining the Maintainer Team -ESLint is an open-source project, and anyone can contribute to the project. If you're interested in becoming part of the maintainer team, stop by our Discord and introduce yourself. +ESLint is an open-source project, and anyone can contribute to the project. If you're interested in becoming part of the maintainer team, stop by our [Discord](https://eslint.org/chat) and introduce yourself. From 50cb55c2297dd4bd140c682033b847c90e00f292 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> Date: Tue, 14 Mar 2023 19:36:19 -0400 Subject: [PATCH 6/7] Apply suggestions from code review Co-authored-by: Milos Djermanovic --- docs/src/maintain/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md index 2fd22c6b51d..142496389ba 100644 --- a/docs/src/maintain/overview.md +++ b/docs/src/maintain/overview.md @@ -29,7 +29,7 @@ ESLint is funded through several sources, including: * [**Open Collective**](https://opencollective.com/eslint): A platform for financing open source projects. * [**GitHub Sponsors**](https://github.com/sponsors/eslint): A platform for funding open source projects associated with Github. * [**Tidelift**](https://tidelift.com/subscription/pkg/npm-eslint): A subscription service that lets enterprises manage and fund the open source projects that their organization uses. -* [**Carbon Ads**](https://www.carbonads.net/open-source): Developer-centric advertising provider used on eslint.org. +* [**Carbon Ads**](https://www.carbonads.net/open-source): Developer-centric advertising provider used on [eslint.org](https://eslint.org/). * [**Stackaid.us**](https://simulation.stackaid.us/github/eslint/eslint): Tool that developers can use to allocate funding to the open source projects they use. ESLint uses this funding for the following purposes: From 820b2cf9f51a943fda7f56918c933a3f82f81ea0 Mon Sep 17 00:00:00 2001 From: Milos Djermanovic Date: Wed, 15 Mar 2023 10:31:54 +0100 Subject: [PATCH 7/7] Update docs/src/maintain/overview.md Co-authored-by: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> --- docs/src/maintain/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/maintain/overview.md b/docs/src/maintain/overview.md index 142496389ba..362637a8a3c 100644 --- a/docs/src/maintain/overview.md +++ b/docs/src/maintain/overview.md @@ -12,7 +12,7 @@ This page explains the different roles and structures involved in maintaining ES ## The ESLint Team -The ESLint team works together to develop and maintain ESLint. To learn more about the different roles on the ESLint team, refer to [Governance](../contribute/governance). To see the current team members, refer to [Team](https://eslint.org/team/). +The ESLint team works together to develop and maintain ESLint. To learn more about the different roles on the ESLint team, refer to [Governance](../contribute/governance). To see the current team members, refer to [Team](/team/). ## Organization Structure