saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
169 Commits 3 Branches 0 Tags 159 KiB
master
Commit Graph

46 Commits

Author SHA1 Message Date
Richard Littauer
0211114475 Remove blockquote from short description 
Closes #22
 2019-12-10 10:12:43 -05:00
Leo Arias
5c9ae7b50a
Suggest to use the standard readme badge 
I'm always reading this specification and when I get to this section I get lost a little trying to find the badge.
 2019-08-07 09:58:12 -06:00
Dominik Salvet
a56a3c9e70 Add Thanks section 2019-06-24 18:57:33 +02:00
Dominik Salvet
1c06b0016c
Update spec.md 
Redundant information about document-based modules has been removed from the Install and Usage sections - it is already stated in their Status subsections.
 2019-06-07 19:20:13 +02:00
Niklas Lindgren
845a854a23 fix: use ascii apostrophy 2019-02-21 14:46:56 +00:00
Niklas Lindgren
5ee173102e fix: than should be then 2019-02-21 14:45:30 +00:00
David Kleuker
88d7650a83 Rename "Contribute" section to "Contributing" 
fixes #84
 2018-10-24 15:55:01 +02:00
Richard Littauer
7c68d892fd fix: Add language specific rules for naming 
closes #81.
 2018-08-20 10:37:42 -04:00
jonahweissman
f9a0a3bdd4
Fix broken link in spec.md 
change link from `readme.md` to actual file `README.md`
 2018-03-08 19:56:42 -05:00
Richard Littauer
f570c3cdd2
Merge pull request #74 from RichardLitt/feat/maintainer-optional 
fix: Maintainer is optional
 2017-11-16 10:35:36 -05:00
Richard Littauer
095aee7683 Merge github.com:RichardLitt/standard-readme 2017-11-14 19:41:27 -05:00
Richard Littauer
0591ce294b fix: Maintainer is optional 
You do not need this for single person repositories. Closes #73
 2017-11-14 19:41:00 -05:00
Richard Littauer
36df2792df Add maintainers to TOC 2017-11-14 19:40:27 -05:00
Titus Wormer
42f1df9241 Add mention of relation to Node and npm 
Closes GH-64.
 2017-11-14 19:11:31 -05:00
Richard Littauer
c435c2daaf docs: make coc section clearer 2017-11-14 16:13:26 -05:00
Richard Littauer
89d405e13a fix: dont require extra sections section 
See d4e79da598 (commitcomment-25611715)
 2017-11-14 15:46:56 -05:00
Richard Littauer
e645c67af8 docs: spruce up coc 
See #68
 2017-11-14 15:32:36 -05:00
Richard Littauer
03360b3b7e
Merge pull request #71 from RichardLitt/feat/definitions 
feat: add definitions section
 2017-11-14 15:22:48 -05:00
Richard Littauer
79cf2c2b8a
Merge pull request #70 from RichardLitt/feat/spdx 
fix: note SPDX for license
 2017-11-14 15:22:39 -05:00
Richard Littauer
d4e79da598 fix: must not wording 
Closes #62
 2017-11-14 15:18:55 -05:00
Richard Littauer
d05361bb82 fix: Make updating subsection an optional suggestion, and describe it 
Closes #65
 2017-11-14 15:13:51 -05:00
Richard Littauer
f9fa67cabb fix: Remove newlines requirement 
Because Markdown enforces this anyway, and I do not think that this requirement is helpful. Closes #58
 2017-11-14 15:00:04 -05:00
Richard Littauer
1123bb8ba4 fix: remove back-to-top suggestion 
This is unnecessary. Closes #60
 2017-11-14 14:57:40 -05:00
Richard Littauer
13063840cb feat: add definitions section 2017-11-14 14:47:02 -05:00
Richard Littauer
e7b67cd4cf fix: note SPDX for license 
Closes #69.
 2017-11-14 14:41:27 -05:00
Sam Hutchings
1d4049f2fa Spell checking and language cleanup 
Initial run through the spec, checking for language and spelling
issues. Corrected.
 2017-05-12 14:10:00 +01:00
Richard Littauer
f3525d4313 Add linting requirement 
Closes #37
 2017-05-08 14:52:53 +02:00
Richard Littauer
24938bbe2d Remove ToC from minimal example 
And make optional clearer. Closes #43
 2017-05-08 13:50:15 +02:00
Richard Littauer
37e4a6c709 Merge pull request #46 from RichardLitt/feat/i18n 
Added i18n note
 2017-01-06 23:54:09 +01:00
Richard Littauer
4e8548cf50 Merge pull request #39 from RichardLitt/feat/add-maintainers 
Added maintainers to spec
 2016-12-28 10:41:43 -05:00
Rhys van der Waerden
3da360d704 Correct table of contents href 
Previously referenced the spec's table of contents instead of the table of contents section.
 2016-12-23 10:05:55 +11:00
Richard Littauer
359b36e837 Added i18n note 
See https://github.com/RichardLitt/standard-readme/issues/38
 2016-11-22 05:28:52 -05:00
Richard Littauer
fc9b7f7cf2 Merge pull request #40 from RichardLitt/feat/h1-heading-note 
Added subtitle option to Top Header Naming
 2016-11-17 09:20:59 -05:00
Richard Littauer
8ef8666e1e Added ToC to spec 2016-10-19 16:38:09 -04:00
Richard Littauer
c5f938af18 Added subtitle option to Top Header Naming 
See #26
 2016-10-19 16:36:49 -04:00
Richard Littauer
8f9adba52b Added maintainers to spec 
See #30
 2016-10-19 15:47:03 -04:00
Darius I. Karel
16885ebed3 spec: must not contain broken links 2016-09-27 10:04:18 +07:00
Richard Littauer
8d74e29490 Spelling errors 2016-08-30 08:54:54 -04:00
JesseWeinstein
8fd1e0c680 Clarify Dependencies and Extra Sections 2016-08-29 19:46:32 -07:00
JesseWeinstein
bc28e71d1f Use a blank line to separate Status & Requirements 
Rather than invisible trailing whitespace.
 2016-08-29 19:16:42 -07:00
JesseWeinstein
28c934ef62 Various wording/formatting adjustements 
This includes some additional guidelines, but is not intended to make any substantive changes.
 2016-08-25 23:40:14 -07:00
Richard Littauer
c555f1f5d2 Added optionality to required things 2016-07-28 13:55:41 -04:00
Richard Littauer
f92456b01f Make install and usage optional for doc repos 
See https://github.com/RichardLitt/standard-readme/issues/21
 2016-07-27 17:22:47 -04:00
Richard Littauer
1bb0e8ea88 Be agnostic about naming of contribute file 2016-07-27 11:26:35 -04:00
Richard Littauer
da40945e8b Remove extra word in headings 2016-07-27 11:26:04 -04:00
Richard Littauer
2986c49901 Move spec to spec, rename Installation to install 2016-07-07 16:24:29 +01:00