Skip to content

Commit

Permalink
draft extend eslint and contribute to eslint TOCs/titles
Browse files Browse the repository at this point in the history
  • Loading branch information
bpmutter committed Jan 8, 2023
1 parent f65c4a9 commit ece1d17
Show file tree
Hide file tree
Showing 19 changed files with 86 additions and 66 deletions.
4 changes: 2 additions & 2 deletions docs/src/contribute/architecture/index.md
Expand Up @@ -2,9 +2,9 @@
title: Architecture
eleventyNavigation:
key: architecture
parent: developer guide
parent: contribute to eslint
title: Architecture
order: 1
order: 5
---

<center><img alt="dependency graph" src="../../assets/images/architecture/dependency.svg"></center>
Expand Down
11 changes: 5 additions & 6 deletions docs/src/contribute/development-environment.md
@@ -1,11 +1,10 @@
---
title: Development Environment
title: Set up a Development Environment
eleventyNavigation:
key: set up a development environment
parent: developer guide
title: Set Up a Development Environment
order: 2

key: development environment
parent: contribute to eslint
title: Set up a Development Environment
order: 6
---

ESLint has a very lightweight development environment that makes updating code fast and easy. This is a step-by-step guide to setting up a local development environment that will let you contribute back to the project.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/contribute/governance.md
Expand Up @@ -2,9 +2,9 @@
title: Governance
eleventyNavigation:
key: governance
parent: maintainer guide
parent: contribute to eslint
title: Governance
order: 4
order: 10

---

Expand Down
10 changes: 4 additions & 6 deletions docs/src/contribute/index.md
@@ -1,11 +1,9 @@
---
title: Contributing
title: Contribute to ESLint
eleventyNavigation:
key: contributing
parent: developer guide
title: Contributing
order: 10

key: contribute to eslint
title: Contribute to ESLint
order: 3
---

One of the great things about open source projects is that anyone can contribute in any number of meaningful ways. ESLint couldn't exist without the help of the many contributors it's had since the project began, and we want you to feel like you can contribute and make a difference as well.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/propose-new-rule.md
@@ -1,6 +1,10 @@
---
title: New Rules

title: Propose a New Rule
eleventyNavigation:
key: propose rule
parent: contribute to eslint
title: Propose a New Rule
order: 2
---

ESLint is all about rules. For most of the project's lifetime, we've had over 200 rules, and that list continues to grow. However, we can't just accept any proposed rule because all rules need to work cohesively together. As such, we have some guidelines around which rules can be part of the ESLint core and which are better off as custom rules and plugins.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/propose-rule-change.md
@@ -1,6 +1,10 @@
---
title: Rule Changes

title: Propose a Rule Change
eleventyNavigation:
key: propose rule change
parent: contribute to eslint
title: Propose a Rule Change
order: 3
---

Occasionally, a core ESLint rule needs to be changed. This is not necessarily a bug, but rather, an enhancement that makes a rule more configurable. In those situations, we will consider making changes to rules.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/pull-requests.md
@@ -1,6 +1,10 @@
---
title: Pull Requests

title: Submit a Pull Request
eleventyNavigation:
key: submit pull request
parent: contribute to eslint
title: Submit a Pull Request
order: 9
---

If you want to contribute to an ESLint repo, please use a GitHub pull request. This is the fastest way for us to evaluate your code and to merge it into the code base. Please don't file an issue with snippets of code. Doing so means that we need to manually merge the changes in and update any appropriate tests. That decreases the likelihood that your code is going to get included in a timely manner. Please use pull requests.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/report-bugs.md
@@ -1,6 +1,10 @@
---
title: Reporting Bugs

title: Report Bugs
eleventyNavigation:
key: report bugs
parent: contribute to eslint
title: Report Bugs
order: 1
---

If you think you've found a bug in ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new/choose) or a [pull request](pull-requests) on GitHub.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/request-change.md
@@ -1,6 +1,10 @@
---
title: Change Requests

title: Request a Change
eleventyNavigation:
key: request change
parent: contribute to eslint
title: Request a Change
order: 4
---

If you'd like to request a change to ESLint, please [create a new issue](https://github.com/eslint/eslint/issues/new/choose) on GitHub. Be sure to include the following information:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/contribute/source-code.md
Expand Up @@ -2,7 +2,7 @@
title: Source Code
eleventyNavigation:
key: getting the source code
parent: developer guide
parent: extend eslint
title: Getting the Source Code
order: 1

Expand Down
9 changes: 4 additions & 5 deletions docs/src/contribute/tests.md
@@ -1,11 +1,10 @@
---
title: Unit Tests
title: Run the Tests
eleventyNavigation:
key: run the tests
parent: developer guide
key: run tests
parent: contribute to eslint
title: Run the Tests
order: 3

order: 7
---

Most parts of ESLint have unit tests associated with them. Unit tests are written using [Mocha](https://mochajs.org/) and are required when making contributions to ESLint. You'll find all of the unit tests in the `tests` directory.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/contribute/work-on-issue.md
@@ -1,6 +1,10 @@
---
title: Working on Issues

title: Work on Issues
eleventyNavigation:
key: work on issues
parent: contribute to eslint
title: Work on Issues
order: 8
---

Our public [issues tracker](https://github.com/eslint/eslint/issues) lists all of the things we plan on doing as well as suggestions from the community. Before starting to work on an issue, be sure you read through the rest of this page.
Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/custom-formatters.md
@@ -1,10 +1,10 @@
---
title: Working with Custom Formatters
title: Custom Formatters
eleventyNavigation:
key: working with custom formatters
parent: developer guide
title: Working with Custom Formatters
order: 6
key: custom formatters
parent: extend eslint
title: Custom Formatters
order: 3

---

Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/custom-parsers.md
@@ -1,10 +1,10 @@
---
title: Working with Custom Parsers
title: Custom Parsers
eleventyNavigation:
key: working with custom parsers
parent: developer guide
title: Working with Custom Parsers
order: 7
key: custom parsers
parent: extend eslint
title: Custom Parsers
order: 4

---

Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/custom-rules.md
@@ -1,10 +1,10 @@
---
title: Working with Rules
title: Custom Rules
eleventyNavigation:
key: working with rules
parent: developer guide
title: Working with Rules
order: 4
key: custom rules
parent: extend eslint
title: Custom Rules
order: 2

---

Expand Down
6 changes: 3 additions & 3 deletions docs/src/extend/index.md
@@ -1,8 +1,8 @@
---
title: Developer Guide
title: Extend ESLint
eleventyNavigation:
key: developer guide
title: Developer Guide
key: extend eslint
title: Extend ESLint
order: 2

---
Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/plugins.md
@@ -1,10 +1,10 @@
---
title: Working with Plugins
title: Create Plugins
eleventyNavigation:
key: working with plugings
parent: developer guide
title: Working with Plugins
order: 5
key: create plugins
parent: extend eslint
title: Create Plugins
order: 1

---

Expand Down
10 changes: 5 additions & 5 deletions docs/src/extend/shareable-configs.md
@@ -1,10 +1,10 @@
---
title: Shareable Configs
title: Share Configurations
eleventyNavigation:
key: shareable configs
parent: developer guide
title: Shareable Configs
order: 8
key: share configs
parent: extend eslint
title: Share Configurations
order: 5

---

Expand Down
8 changes: 4 additions & 4 deletions docs/src/integrate/nodejs-api.md
@@ -1,10 +1,10 @@
---
title: Node.js API
title: Node.js API Reference
eleventyNavigation:
key: node.js api
parent: developer guide
title: Node.js API
order: 9
parent: extend eslint
title: Node.js API Reference
order: 6

---

Expand Down

0 comments on commit ece1d17

Please sign in to comment.