[go: nahoru, domu]
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.

Sign up for GitHub

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

Jump to bottom

Docs: explain how to deal with check-configs and check-docs scripts #8037

Closed
2 tasks done
auvred opened this issue Dec 7, 2023 · 0 comments · Fixed by #9258
Closed
2 tasks done

Docs: explain how to deal with check-configs and check-docs scripts #8037

auvred opened this issue Dec 7, 2023 · 0 comments · Fixed by #9258
Assignees
@JoshuaKGoldberg
Labels
documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. team assigned A member of the typescript-eslint team should work on this.

Comments

@auvred
Copy link
Member
auvred commented Dec 7, 2023

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Ref: #8034

I believe https://typescript-eslint.io/contributing/local-development is the best place to put it

This is what it looked like before it disappeared (maybe it may be helpful):

typescript-eslint/CONTRIBUTING.md

Lines 52 to 74 in f373fac

### Validating Your Changes
We have a sophisticated CI process setup which gets run on every PR. You must pass all of the checks for us to consider merging your PR. Here is a list of checks that are done automatically, that you can also perform locally before pushing.
- Ensure your code is properly formatted.
- You can run `yarn format` in any package or in the root.
- Alternatively, you can run prettier on save.
- Ensure there are no typechecking errors.
- You can run `yarn typecheck` in any package or in the root.
- Ensure your changes are adequately tested.
- You can run `yarn test` in any package.
- [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
- We aim for around `90%` branch coverage for every PR.
- Coverage reports should automatically be generated locally, and 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.
- Ensure you have no lint errors.
- You can run `yarn lint` in any package or in the root.
- You can run `yarn lint-markdown` in the root.
- If you have made changes to any markdown documentation, ensure there are no spelling errors
- You can run `yarn check-spelling` in the root.
- Or if you are using vscode, you can use [`Code Spell Checker`](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) plugin.
- If you have made changes within the `eslint-plugin` package, ensure the configs and documentation are valid.
- You can run `yarn check-configs` and `yarn check-docs` in the root, or in the `eslint-plugin` folder.

Affected URL(s)

Potentially https://typescript-eslint.io/contributing/local-development
@auvred auvred added documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look labels Dec 7, 2023
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Dec 7, 2023
@JoshuaKGoldberg JoshuaKGoldberg added team assigned A member of the typescript-eslint team should work on this. and removed accepting prs Go ahead, send a pull request that resolves this issue labels Jun 4, 2024
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jun 4, 2024
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jun 4, 2024
Merged
3 tasks
@github-actions github-actions bot added the locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. label Jun 17, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. team assigned A member of the typescript-eslint team should work on this.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: mention rule scripts under Local Development JoshuaKGoldberg/typescript-eslint
2 participants
@JoshuaKGoldberg @auvred