Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

Better document and support auto-generated configs for contributors #700

Closed
JoshuaKGoldberg opened this issue Dec 27, 2018 · 1 comment
Closed
Labels
Domain: Documentation Rules or repository tasks related to how to document code. Domain: Tooling Repository tasks around improving source tooling. Status: Accepting PRs Status: In Discussion Please continue discussing the proposed change before sending a pull request.

Comments

@JoshuaKGoldberg
Copy link

Quoting @IllusionMH in #696:

I have an impression (may be wrong) that contributors are not sure if they should add/commit changes to automatically generated files (specifically recommended_ruleset.js and tslint-warnings.csv).

It may worth to add information to CONTRIBUTING.md that changes in these files related to new rules should be also commited. And during review check if changes are present and ask to add for example recommended: 'false, // to strict' to rule metadata.

And my response:

Agreed. I think it'd be good to have a comment on top of recommended_ruleset.js linking to those docs too.

I wonder if we should enable them as a commit hook, as with Prettier?

@JoshuaKGoldberg JoshuaKGoldberg added Status: Accepting PRs Status: In Discussion Please continue discussing the proposed change before sending a pull request. Domain: Tooling Repository tasks around improving source tooling. Domain: Documentation Rules or repository tasks related to how to document code. labels Dec 27, 2018
@JoshuaKGoldberg
Copy link
Author

☠️ It's time! ☠️

Per #876, this repository is no longer accepting feature pull requests. TSLint is being deprecated and we recommend you switch to https://typescript-eslint.io.

Thanks for open sourcing with us, everyone!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Domain: Documentation Rules or repository tasks related to how to document code. Domain: Tooling Repository tasks around improving source tooling. Status: Accepting PRs Status: In Discussion Please continue discussing the proposed change before sending a pull request.
Projects
None yet
Development

No branches or pull requests

1 participant