diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..b735373 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/custom.md similarity index 94% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/custom.md index 60ae8df..26c2fa1 100644 --- a/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -1,3 +1,9 @@ +--- +name: Custom issue template +about: Open a general issue request + +--- + ## Expected Behavior diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..066b2d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/.npmignore b/.npmignore deleted file mode 100644 index 69a0381..0000000 --- a/.npmignore +++ /dev/null @@ -1,33 +0,0 @@ -/.idea -/.nyc_output -/.vscode -/coverage -/dist -/dist-test -/docs -/lib-test -/not-ported-extensions -/src -/test -/transpiled-code -/typings -CODE_OF_CONDUCT.md -CONTRIBUTING.md -ISSUE_TEMPLATE.md -PULL_REQUEST_TEMPLATE.md -karma.conf.js -package-lock.json -tsconfig.json -tsconfig.test.json -tslint.json -tslint.test.json -webpack.config.js -yarn.lock -.auditignore -.editorconfig -.gitignore -.istanbul.yml -.npmignore -.prettierrc -.publishrc -.travis.yml \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 23108bb..fda3778 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Prepare package for stable version (see #76). +- Update GitHub Templates (see #78). + - Update dev dependencies to latest version. ## RobotlegsJS-SignalCommandMap 0.2.0 diff --git a/package.json b/package.json index 760e54b..d748360 100644 --- a/package.json +++ b/package.json @@ -64,6 +64,12 @@ "url": "https://github.com/RobotlegsJS/RobotlegsJS-SignalCommandMap/issues" }, "homepage": "https://github.com/RobotlegsJS/RobotlegsJS-SignalCommandMap#readme", + "files": [ + "lib" + ], + "directories": { + "lib": "./lib" + }, "dependencies": { "@robotlegsjs/core": "^0.2.1", "@robotlegsjs/signals": "^0.2.0"