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

Better describe and suggest new rules' version options #648

Closed
JoshuaKGoldberg opened this issue Nov 6, 2018 · 1 comment · Fixed by #817
Closed

Better describe and suggest new rules' version options #648

JoshuaKGoldberg opened this issue Nov 6, 2018 · 1 comment · Fixed by #817
Labels
Domain: Documentation Rules or repository tasks related to how to document code. Status: Needs Investigation We're not sure whether this a good thing to do. Type: Question
Milestone
6.1.0-beta

Comments

@JoshuaKGoldberg
Copy link

Following @IllusionMH's comment in #647 (comment) - we should have a better template for what users should put in README.md as the rules' starting version.

During the release process, we change them to what's correct, but until then it can be misleading to see incorrect version numbers in the big README.md table.

This should be a small intermediate fix until #575 gets rid of that table.
@JoshuaKGoldberg JoshuaKGoldberg added Type: Question Status: Needs Investigation We're not sure whether this a good thing to do. Domain: Documentation Rules or repository tasks related to how to document code. labels Nov 6, 2018
@IllusionMH
Copy link
Contributor

In offline discussion @next was picked.

@IllusionMH IllusionMH mentioned this issue Feb 9, 2019
Merged
4 tasks
IllusionMH added a commit to IllusionMH/tslint-microsoft-contrib that referenced this issue Feb 10, 2019
@IllusionMH
Update CONTRIBUTING.md with detais about README.md actions (fixes mic…
5f9cf68 
…rosoft#648)
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. Status: Needs Investigation We're not sure whether this a good thing to do. Type: Question
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
2 participants
@IllusionMH @JoshuaKGoldberg