From d049f974103e530ef76ede25af701635caf1f405 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> Date: Wed, 15 Mar 2023 06:17:12 -0400 Subject: [PATCH] docs: 'How ESLint is Maintained' page (#16961) * docs: How eslint is maintained page * implement reviewer feedback * remove trailing space * remove todo * Apply suggestions from code review Co-authored-by: Nitin Kumar Co-authored-by: Nicholas C. Zakas * Apply suggestions from code review Co-authored-by: Milos Djermanovic * Update docs/src/maintain/overview.md Co-authored-by: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> --------- Co-authored-by: Nitin Kumar Co-authored-by: Nicholas C. Zakas Co-authored-by: Milos Djermanovic --- 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 | 44 +++++++++++++++++++++++ docs/src/maintain/review-pull-requests.md | 2 +- docs/src/maintain/working-groups.md | 2 +- 6 files changed, 52 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 013a5a1ec0b..29c3ab89f30 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, how to interact with users who open issues, and how to close issues effectively. diff --git a/docs/src/maintain/manage-issues.md b/docs/src/maintain/manage-issues.md index 58cc9deb9e6..6cfdbc93b19 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 118edc79399..7a5e763a009 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..362637a8a3c --- /dev/null +++ b/docs/src/maintain/overview.md @@ -0,0 +1,44 @@ +--- +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 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 + +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 + +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](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: + +* 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](https://eslint.org/chat) and introduce yourself. diff --git a/docs/src/maintain/review-pull-requests.md b/docs/src/maintain/review-pull-requests.md index e71ef9add7b..c1711dfd65c 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 cfb5c40ec74..659ac04f73d 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 [Technical Steering Committee](../contribute/governance#technical-steering-committee-tsc) (TSC) may form working groups to focus on a specific area of the project.