chore: update docs for repo standards #532
Conversation
github-actions
bot
added
the
type: chore
|
|
||
| We'd love to hear from you! So, if you have any questions, comments, or bugs, let us know! You can either: | ||
|
|
||
| - Open an issue on this repository |
There was a problem hiding this comment.
this is kindof related to my comment above about the questions section
| promote a positive and inclusive environment. | ||
| * **Use a clear and descriptive title** for the issue to identify the problem. | ||
| * **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, **don't just say what you did, but explain how you did it**. | ||
| * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). |
There was a problem hiding this comment.
not that many people will read this in depth vs the github issue template, but we prob do want to emphasize that simple repos that reproduce the issue are preferred, and simple means anyone can clone and deploy (aka no api keys, no db setup, etc)
There was a problem hiding this comment.
It would make sense to have a full doc on how to do this actually, akin to this one from Gatsby, and include a field in an issue form specifically with a link to the repro
| @@ -0,0 +1,19 @@ | |||
| ### Requirements for Contributing Documentation | |||
There was a problem hiding this comment.
Could we use issue forms instead of templates?
| promote a positive and inclusive environment. | ||
| * **Use a clear and descriptive title** for the issue to identify the problem. | ||
| * **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, **don't just say what you did, but explain how you did it**. | ||
| * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). |
There was a problem hiding this comment.
It would make sense to have a full doc on how to do this actually, akin to this one from Gatsby, and include a field in an issue form specifically with a link to the repro
CONTRIBUTING.md
Outdated
| * Place requires in the following order: | ||
| * Built in Node Modules (such as `path`) | ||
| * Other NPM Installed Node Modules (such as `fs-extra`) | ||
| * Local Modules (using relative paths) |
There was a problem hiding this comment.
I think this is all enforced by eslint. We can just say that they need to run the format command.
CONTRIBUTING.md
Outdated
|
|
||
| 1. Merge the release PR | ||
| 2. Run `npm publish` | ||
| * Use [Markdown](https://daringfireball.net/projects/markdown). |
There was a problem hiding this comment.
Better to link to the gfm docs
|
Closing this cuz I guess it's old |
* gh issues to failure list * add token * add based on file name or test name * add comments * Update tools/deno/ghIssues2json.ts Co-authored-by: Philippe Serhal <philippe.serhal@netlify.com> * return empty arr if no match * allow for multi test names * add schedule * fix multi name setup * Update tools/deno/ghIssues2json.ts Co-authored-by: Philippe Serhal <philippe.serhal@netlify.com> * Update tools/deno/ghIssues2json.ts Co-authored-by: Philippe Serhal <philippe.serhal@netlify.com> * chore: format with prettier --------- Co-authored-by: Philippe Serhal <philippe.serhal@netlify.com> Co-authored-by: taty2010 <taty2010@users.noreply.github.com>
few little bits in here. lmk what you think