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

Add more info about writing new rules to Contribution guidlines #779

Closed
IllusionMH opened this issue Jan 9, 2019 · 1 comment
Closed
Labels
Domain: Documentation Rules or repository tasks related to how to document code. Status: Accepting PRs Status: In Discussion Please continue discussing the proposed change before sending a pull request.

Comments

@IllusionMH
Copy link
Contributor

Feature request

Is your feature request related to a problem? Please describe.
CONTRIBUTING.md doesn't have information or links to TSLint documentation on how to write custom rules. Only links to testing (for new format) are available ATM.

Better to have all useful for contribution links in CONTRIBUTING.md. In this way it will be easier for newcomers to find all necessary info.

Describe the solution you'd like
I don't think that there is need to write own guide, but to suggestion check official docs for writing new rules (at least Custom Rules and Performance Tips)

Describe alternatives you've considered
Can't think of anything.

Additional context
Suggestion from #770 PR comment

@IllusionMH IllusionMH added Status: Accepting PRs Status: In Discussion Please continue discussing the proposed change before sending a pull request. Domain: Documentation Rules or repository tasks related to how to document code. labels Jan 9, 2019
@IllusionMH IllusionMH mentioned this issue Jan 9, 2019
4 tasks
@JoshuaKGoldberg
Copy link

☠️ 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. 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

2 participants