-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move remaining docs files into website (#6138)
* [WIP] chore: move remaining docs files into website * Updated code comments * Cleaned up README.mds * Added Architecture.md * Removed docs/ prefix from URLs * Massaged internal links * Moved ASTs page to blog post * Corrected inter-links * Added more redircts * Split up Contributing * Fixed Markdown linting * Correctly fixed linting * Went the other way fixing markdown linting * Another cspell complaint * Updated snapshot * A bit more standardization * Casing fixes * One more casing fix * Fixed up many /docs references * chore: added blog article: 'ASTs and TypeScript-ESLint' * a little more merging * Added netlify.toml redirect * Build fixups post-merge
- Loading branch information
1 parent
b9dfc0a
commit 0af822a
Showing
65 changed files
with
1,292 additions
and
1,454 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,112 +1,4 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing to TypeScript ESLint! 💜 | ||
|
|
||
| > Make sure you read our [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing. | ||
| ## Raising Issues | ||
|
|
||
| So you've got a bug report, documentation request, or feature suggestion? | ||
| Great! | ||
|
|
||
| Do: | ||
|
|
||
| - Make sure you're using the [latest version of our packages](https://github.com/typescript-eslint/typescript-eslint/releases) | ||
| - Search [all opened and closed issues](https://github.com/typescript-eslint/typescript-eslint/issues?q=is%3Aissue+) to make sure your issue wouldn't be a duplicate | ||
| - Fill out the [appropriate issue template](https://github.com/typescript-eslint/typescript-eslint/issues/new/choose) completely | ||
| - Provide as much information as you can | ||
|
|
||
| ### Questions and Support Requests | ||
|
|
||
| We do not have the bandwidth to handle questions or support requests in the issue tracker. | ||
| You can instead: | ||
|
|
||
| - Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript-eslint 'StackOverflow questions tagged with typescript-eslint') using the `typescript-eslint` tag | ||
| - Publicly tweet [@tseslint on Twitter](https://twitter.com/tseslint) | ||
|
|
||
| > Note that requests to add documentation _are_ allowed, even encouraged! 📝 | ||
| ## Commenting | ||
|
|
||
| Please do comment on any open issue if you have more information that would be useful. | ||
|
|
||
| Don't: | ||
|
|
||
| - Leave useless comments such as _"+1"_ or _"when's this getting fixed?"_ that only act as spam | ||
| - If you have nothing to add but enthusiasm and joy, add a reaction such as 👍 | ||
| - Bring up unrelated topics in existing issues: instead, file a new issue | ||
| - Comment on closed PRs: instead, [file a new issue](#raising-issues) | ||
| - Comment on commits directly, as those comments are not searchable: instead, file a new issue | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| > See [DEVELOPMENT.md](./DEVELOPMENT.md) for details on how to get started developing locally. | ||
| Do: | ||
|
|
||
| - Only send pull requests that resolve [open issues marked as `accepting prs`](https://github.com/typescript-eslint/typescript-eslint/issues?q=is%3Aissue+is%3Aopen+label%3A%22accepting+prs%22) | ||
| - One exception: extremely minor documentation typos | ||
| - Fill out the pull request template in full | ||
| - Validate your changes per [Development > Validating Changes](./DEVELOPMENT.md#validating-changes) before un-[drafting your PR](https://github.blog/2019-02-14-introducing-draft-pull-requests) | ||
|
|
||
| Don't: | ||
|
|
||
| - Force push after opening a PR | ||
| - Reasoning: GitHub is not able to track changes across force pushes, which makes it take longer for us to perform incremental reviews | ||
| - Comment asking for updates | ||
| - Reasoning: Your PR hasn't been forgotten! The volunteer maintainers have limited time to work on the project, and they will get to it as soon as they are able. | ||
|
|
||
| ### Raising a PR | ||
|
|
||
| Once your changes are ready, you can raise a PR! 🙌 | ||
| The title of your PR should match the following format: | ||
|
|
||
| ```text | ||
| <type>(<package>): <short description> | ||
| ``` | ||
|
|
||
| You can find more samples of good past PR titles in [recent commits to `main`](https://github.com/typescript-eslint/typescript-eslint/commits/main). | ||
|
|
||
| ```text | ||
| fix(scope-manager): correct handling for class static blocks | ||
| ``` | ||
|
|
||
| ```text | ||
| docs: Fix links to getting started in README.md | ||
| ``` | ||
|
|
||
| Within the body of your PR, make sure you reference the issue that you have worked on, as well as pointing out anything of note you wish us to look at during our review. | ||
|
|
||
| > We do not care about the number, or style of commits in your history, because we squash merge every PR into `main`. | ||
| > Feel free to commit in whatever style you feel comfortable with. | ||
| #### type | ||
|
|
||
| Must be one of the following: | ||
|
|
||
| <!-- Keep this synchronized with /.github/workflows/semantic-pr-titles.yml --> | ||
|
|
||
| - `docs` - if you only change documentation, and not shipped code | ||
| - `feat` - for any new functionality additions | ||
| - `fix` - for any bug fixes that don't add new functionality | ||
| - `test` - if you only change tests, and not shipped code | ||
| - `chore` - anything else | ||
|
|
||
| #### package | ||
|
|
||
| The name of the package you have made changes within, (e.g. `eslint-plugin`, `parser`, `typescript-estree`). | ||
| If you make significant changes across multiple packages, you can omit this (e.g. | ||
| `feat: foo bar`). | ||
|
|
||
| #### short description | ||
|
|
||
| A succinct title for the PR. | ||
|
|
||
| ### Addressing Feedback and Beyond | ||
|
|
||
| With your PR raised and the CI passing, your PR will [wait in the queue to be reviewed](https://github.com/typescript-eslint/typescript-eslint/pulls?q=is%3Apr+is%3Aopen+sort%3Acreated-asc+-label%3A%22breaking+change%22+-label%3A%22awaiting+response%22+-label%3A%221+approval%22+-label%3A%22DO+NOT+MERGE%22+status%3Asuccess). | ||
| We generally review PRs oldest to newest, unless we consider a newer PR higher priority (e.g. if it's a bug fix). | ||
|
|
||
| Once we have reviewed your PR, we will provide any feedback that needs addressing. | ||
| If you feel a requested change is wrong, don't be afraid to discuss with us in the comments. | ||
| Once the feedback is addressed, and the PR is reviewed, we'll ensure the branch is up to date with `main`, and merge it for you. | ||
| See **https://typescript-eslint.io/contributing** for our contributing guidelines. | ||
| Thanks! 💖 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,4 @@ | ||
| # Development | ||
|
|
||
| Thank you for your interest in developing on TypeScript ESLint! ❤️🔥 | ||
|
|
||
| > See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our general contribution flows. | ||
| ## Setup | ||
|
|
||
| After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo): | ||
|
|
||
| ```shell | ||
| git clone https://github.com/<your-name-here>/typescript-eslint | ||
| cd typescript-eslint | ||
| yarn | ||
| ``` | ||
|
|
||
| Postinstall scripts will then fully build your repository locally with (`yarn build`). | ||
| At this point, you're ready to develop! 🚀 | ||
|
|
||
| ## Builds | ||
|
|
||
| You can run `yarn build` in any package or in the root to build the package(s). | ||
|
|
||
| Keep in mind that packages generally depend on each other's built outputs, and you'll need to `yarn build` dependents for their consumers to receive any new local changes. | ||
| For example, if you make a change within `scope-manager` and want to use it in `eslint-plugin`, you'll need to `yarn build` either from the root or within `packages/scope-manager`. | ||
|
|
||
| ## Validating Changes | ||
|
|
||
| The following checks are all run on pull requests automatically. | ||
| You can also perform them locally. | ||
|
|
||
| ### Formatting | ||
|
|
||
| We use [Prettier](https://prettier.io) to auto-format code. | ||
| A Git pre-commit hook should apply it to all committed changes. | ||
| ALternately, you can run `yarn format` in any package or in the root. | ||
|
|
||
| ### Linting | ||
|
|
||
| All code changes must pass ESLint. | ||
| You can run `yarn lint` in any package or in the root. | ||
|
|
||
| ### Proofreading | ||
|
|
||
| Changes must pass two linters for documentation and naming, the commands for which may be run from the root: | ||
|
|
||
| - `yarn check-spelling`: [CSpell](https://cspell.org), for all code | ||
| - `yarn lint-markdown`: [Markdownlint](https://github.com/DavidAnson/markdownlint), for Markdown documentation | ||
|
|
||
| ### Tests | ||
|
|
||
| All code changes should ideally be unit tested if possible. | ||
| You can run `yarn test` in any package to run its tests. | ||
|
|
||
| > [VS Code launch tasks](https://code.visualstudio.com/docs/editor/tasks) tasks are provided that allow [visual debugging](https://code.visualstudio.com/docs/editor/debugging) tests | ||
| #### Code Coverage | ||
|
|
||
| We aim for 100% code coverage in all PRs when possible, except in the `website/` package. | ||
| Coverage reports are be generated locally whenever `yarn test` is run. | ||
|
|
||
| The `codecov` bot should also comment on your PR with the percentage, as well as links to the line-by-line coverage of each file touched by your PR. | ||
|
|
||
| ### Type Checking | ||
|
|
||
| All code should pass TypeScript type checking. | ||
| You can run `yarn typecheck` in any package or in the root to run `tsc`. | ||
|
|
||
| > Run `yarn typecheck -w` to start `tsc` in watch mode. | ||
| See **https://typescript-eslint.io/contributing/development** for our development instructions. | ||
| Thanks! 💖 |
Oops, something went wrong.