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

Make strict order of rules in README.md #816

Closed
IllusionMH opened this issue Feb 9, 2019 · 0 comments · Fixed by #817
Closed

Make strict order of rules in README.md #816

IllusionMH opened this issue Feb 9, 2019 · 0 comments · Fixed by #817
Labels
Domain: Documentation Rules or repository tasks related to how to document code.
Milestone
6.1.0-beta

Comments

@IllusionMH
Copy link
Contributor

Feature request

Is your feature request that we implement a new rule?
No

Is your feature request related to a problem? Please describe.
I've noticed that rules are not sorted alphabetically which might make it harder to find rules.
As was discussed with @JoshuaKGoldberg offline -#575 is preferred fix for documentation, however, enforcing sort order in a meantime is acceptable fix

Describe the solution you'd like
Add build task to fail build if rules in README.md are out of order.
create-rule task should add all markup for rule entry in correct place.

Describe alternatives you've considered
Implement #575, but will require more effort.
@IllusionMH IllusionMH added the Domain: Documentation Rules or repository tasks related to how to document code. label Feb 9, 2019
IllusionMH added a commit to IllusionMH/tslint-microsoft-contrib that referenced this issue Feb 9, 2019
@IllusionMH
Validate order of rules in README.md (fixes microsoft#816)
6d47b4e
IllusionMH added a commit to IllusionMH/tslint-microsoft-contrib that referenced this issue Feb 9, 2019
@IllusionMH
create-rule task also updates README (fixed microsoft#816)
310b54e
@IllusionMH IllusionMH mentioned this issue Feb 9, 2019
Merged
4 tasks
JoshuaKGoldberg pushed a commit that referenced this issue Feb 10, 2019
@IllusionMH
Strict order of rules in README.md (#817)
f70d669 
* Validate order of rules in README.md (fixes #816)

* Fix rules order in README.md

* create-rule task also updates README (fixed #816)

* Update CONTRIBUTING.md with detais about README.md actions (fixes #648)
@IllusionMH IllusionMH added this to the 6.1.0-beta milestone Feb 19, 2019
apawast pushed a commit to lupine86/tslint-microsoft-contrib that referenced this issue Feb 26, 2019
@IllusionMH @apawast
Strict order of rules in README.md (microsoft#817)
124aeb5 
* Validate order of rules in README.md (fixes microsoft#816)

* Fix rules order in README.md

* create-rule task also updates README (fixed microsoft#816)

* Update CONTRIBUTING.md with detais about README.md actions (fixes microsoft#648)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Domain: Documentation Rules or repository tasks related to how to document code.
Projects
None yet
Milestone
6.1.0-beta
Development

Successfully merging a pull request may close this issue.

Strict order of rules in README.md IllusionMH/tslint-microsoft-contrib
1 participant
@IllusionMH