diff --git a/.gitignore b/.gitignore index aa6a2e4a..e0809902 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ node_modules dist lib +npm-debug.log diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..c1a252fa --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,25 @@ +# Problem + +A short explanation of your problem or use-case is helpful! + +**Input** + +Here's how I'm using normalizr: + +```js +// Add as much relevant code and input as possible +// const mySchema = new Schema('myschema'); +// normalize({ .../* fill in some input */ }, mySchema); +``` + +**Output** + +Here's what I expect to see when I run the above: + +```js +// What you expect to see after running normalizr with your provided input, schema, etc (above) +// { +// result: [1, 2], +// entities: { ... } +// } +``` diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..44c3dead --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +# Problem + +Explain the problem that this pull request aims to resolve. + +# Solution + +Explain your approach. Sometimes it helps to justify your approach against some others that you didn't choose to explain why yours is better. + +# TODO + +*Fill in the following:* + +- [ ] Add & Update Tests