Add CONTRIBUTING doc #4
Conversation
|
|
||
| Our code formatting rules are defined in [.eslintrc.js](https://github.com/inthepocket/cookie-though/blob/master/.eslintrc.js). You can check your code against these standards by running: | ||
|
|
||
| ```console |
There was a problem hiding this comment.
Note that the correct language for console entries is console, not sh which means the sh shell specifically or sh scripts.
|
We first need to have #3 |
|
Maybe it would be better if we would refer to this document from the |
Indeed, much like things like standard-readme define: https://github.com/RichardLitt/standard-readme
That won't make Github highlight it, unless it lives top-level in your docs folder. |
|
Yes, then I would suggest changing the link in |
Adding a contributing doc in the correct location will make Github highlight this document to first-time contributors:
(+ it's also more widely expected than linking to an external site)
More: https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors