Skip to content
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

docs: 'How ESLint is Maintained' page #16961

Merged
merged 7 commits into from Mar 15, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/maintain/index.md
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Governance is still under Contribute right now, do we want to move it as part of this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's keep it there. i remember when we were doing the IA updates, there was some discussion on the matter, and we decided at the time to keep governance in Contribute.


## [Manage Issues](manage-issues)

Describes how to deal with issues when they're opened, when interacting with users, and how to close them effectively.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/maintain/manage-issues.md
Expand Up @@ -4,7 +4,7 @@ eleventyNavigation:
key: manage issues
parent: maintain eslint
title: Manage Issues
order: 1
order: 2

---

Expand Down
2 changes: 1 addition & 1 deletion docs/src/maintain/manage-releases.md
Expand Up @@ -4,7 +4,7 @@ eleventyNavigation:
key: manage releases
parent: maintain eslint
title: Manage Releases
order: 3
order: 4

---

Expand Down
50 changes: 50 additions & 0 deletions 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we'd want to use this verbatim, but here's an overview. You can pick and choose from this:

The OpenJS Foundation provides the 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.

While the OpenJS Foundation does not participate in the day-to-day functioning of the project, they are a resource for ESLint should we need legal advice or representation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx, this is perfect. adapting into the answer.


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.
bpmutter marked this conversation as resolved.
Show resolved Hide resolved
* [**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
bpmutter marked this conversation as resolved.
Show resolved Hide resolved
* 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?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This info is actually covered in the governance doc

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can probably say "Stop by Discord and introduce yourself" as an easier way to get people started.

2 changes: 1 addition & 1 deletion docs/src/maintain/review-pull-requests.md
Expand Up @@ -4,7 +4,7 @@ eleventyNavigation:
key: review pull requests
parent: maintain eslint
title: Review Pull Requests
order: 2
order: 3

---

Expand Down
2 changes: 1 addition & 1 deletion docs/src/maintain/working-groups.md
Expand Up @@ -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.
Expand Down