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.

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

Add special rules for document types #1

Closed
wooorm opened this issue Jun 2, 2015 · 1 comment
Closed

Add special rules for document types #1

wooorm opened this issue Jun 2, 2015 · 1 comment
Labels
🙅 no/wontfix This is not (enough of) an issue for this project

Comments

@wooorm
Copy link
Member

wooorm commented Jun 2, 2015

  • readme: idea: standard-readme standard/standard#141 has a great list of useful “readme rules”;
  • history:
  • maybe validate the headings to a certain standard (\d\.\d\.\d \/ \d{4}-\d{2}-\d{2});
  • maybe require a commit reference at the end of a list-item?
  • \.\d — man section document (e.g., mdast.1.md):
  • Have a main heading in the form of \w+ \(\d\) -- .+
  • Have a synopsis heading (maybe validate its content?);
  • Have a description, bugs, and author heading;

...more?

@wooorm wooorm added 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have help wanted 🙏 This could use your insight or help labels Jan 13, 2016
@wooorm
Copy link
Member Author

wooorm commented Apr 1, 2016

If people want this they should create external rules.

@wooorm wooorm closed this as completed Apr 1, 2016
@wooorm wooorm added 🙅 no/wontfix This is not (enough of) an issue for this project and removed help wanted 🙏 This could use your insight or help 🦋 type/enhancement This is great to have 🙉 open/needs-info This needs some more info labels Aug 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🙅 no/wontfix This is not (enough of) an issue for this project
Development

No branches or pull requests

1 participant