From eac94375a208c5d2542e12894446f1ff57973724 Mon Sep 17 00:00:00 2001 From: Wessel Tip Date: Fri, 12 Apr 2019 20:05:29 +0200 Subject: [PATCH] Add templates --- .github/CONTRIBUTING.md | 14 ++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 10 +++++++++ 4 files changed, 70 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..02cec26 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing + +**The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the [Discord](https://discord.gg/SV7DAE9) instead of opening an issue – you will get redirected there anyway.** + +If you wish to contribute to Yorushika, feel free to fork the repository and submit a pull request. +[ESLint](https://eslint.org/) is used to correct most typo's you make, so it would be helpful if you added [ESLint](https://eslint.org/) to your editor of choice) + +## Setup +To get ready to work on the codebase, please do the following: + +1. Fork & clone the repository, and make sure you're on the **master** branch +2. Run `yarn --dev` or `npm install --dev` +4. Code your heart out and test using `yarn test` or `npm run test`! +6. [Submit a pull request](https://github.com/PassTheWessel/yorushika/compare) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5fa8c4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug Report +about: Report an issue with wumpfetch +title: "[BUG] Somenthing broke" +labels: bug +assignees: PassTheWessel + +--- + +**Please describe the problem you are having in as much detail as possible:** + + +**Include a reproducible code sample here, if possible:** +```js +// Place your code here +``` + +**Further details:** +- Node.js version: +- Operating system: + + + +- [ ] I have also tested the issue on latest master, commit hash: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c027ba6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Request a feature for wumpfetch +title: "[ENHANCEMENT] This is an amazing new idea!" +labels: enhancement +assignees: PassTheWessel + +--- + +**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 ideal solution** +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/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..1f65093 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ +**Please describe the changes this PR makes and why it should be merged:** + + +**Status** +- [ ] Code changes have been tested and there aren't any typos in it + +**Semantic versioning classification:** +- [ ] This PR changes wumpfetch's core codebase (methods or parameters added) + - [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed) +- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc. \ No newline at end of file