Christian Bundy
acf94e2d2e
Add note about pre-commit hook
2020-11-22 21:08:47 +01:00
Christian Bundy
41cf751389
Fix "tpo" typo
...
Problem: I wrote "tpo". I meant "typo".
Solution: Fix the tpo.
2020-04-13 09:03:37 -07:00
sean billig
974fb7fc07
minor doc fixes; add gh cli instructions
2020-03-28 11:34:04 -07:00
Christian Bundy
3627ce4658
Fix CSpell error in example typo
...
Problem: The sample typo in `docs/contributing.md` was failing our
spell-check test.
Solution: Disable the spell-chack on that line.
2020-03-27 13:47:50 -07:00
Christian Bundy
927c356303
Add contributing and maintainting documents
...
Problem: We had our contract in `contributing.md` but that didn't really
give actionable information on how to contribute or how to maintain this
project.
Solution: Move contract to `contract.md` and start documents for
contributing and maintaining.
2020-03-27 12:41:51 -07:00
Christian Bundy
1dd741a381
Replace "must" with "shall" in contributing.md
...
Problem: The word "shall" is ambiguous and seems pretentious rather than
friendly. More info here: https://www.plainlanguage.gov/guidelines/conversational/shall-and-must/
Solution: Replace "shall" with "must". It has the same semantics with
none of the ambiguity or cultural baggage.
2020-01-30 09:12:58 -08:00
Christian Bundy
04c5e97789
Appease linter with `npm run fix`
...
Problem: `docs/contributing.md` was failing the Prettier test.
Solution: `npm run fix`
2020-01-29 18:20:06 -05:00
Jonathan Dahan
a3c08a6341
Relax MUST to SHOULD for commit message format
2020-01-28 14:33:06 -05:00
Jonathan Dahan
a4ff159b94
Thank and explain why we have contributing.md
2020-01-28 14:33:06 -05:00
Jonathan Dahan
ffbee28f88
explain that our contributing.md is an implementation of C4
2020-01-28 14:33:06 -05:00
Jonathan Dahan
e2dd57be3d
remove liquid templates from contributing.md
2020-01-28 14:33:06 -05:00
Jonathan Dahan
a3265dc635
add upstream C4/42 contributing document
2020-01-28 14:33:05 -05:00
Jonathan Dahan
fed37b1e57
rename contributing to architecture
2020-01-28 12:25:22 -05:00
Christian Bundy
b34b04c2c2
Experiment with common-good module
2020-01-21 16:22:19 -08:00
Christian Bundy
e1ea520e3b
Add documentation on new layer style
2020-01-09 09:35:39 -08:00
Christian Bundy
5b115f5004
Add spell-check for Markdown files in project
2019-08-13 14:40:08 -07:00
Christian Bundy
c91b74eb8f
Refactor directories, add docs, fix profile header
2019-07-02 20:52:49 -07:00
Christian Bundy
e68e3a9a86
Add contributor notes to contrib document
2019-06-28 18:56:35 -07:00
Christian Bundy
3e353f312c
Add contributing guidelines
2019-06-27 15:04:54 -07:00