Merge pull request weiameili#15 from im-coder-lg/master

Issue forms, Pull Request Template, etc.

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,52 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug"]
+assignees:
+  - weiameili
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  
+  - type: textarea
+    id: bug-details
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "Describe your bug here"
+    validations:
+      required: true
+  - type: textarea
+    id: expectations
+    attributes:
+      label:  What did you expect to happen?
+      description: Describe what you expected to happen.
+      placeholder: Describe what you expected to happen.
+      value: "I expected to see ..."
+  - type: dropdown
+    id: version
+    attributes:
+      label: Pensela's version
+      description: What version of Pensela are you running?
+      options:
+        - Compiled from source
+        - v1.2.3
+        - v1.1.3
+        - v1.1.2
+        - v1.1.1
+        - v1.1.0
+        - v1.0.0
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/weiameili/Pensela/blob/master/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question
+    url: https://github.com/weiameili/Pensela/discussions/new
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,69 @@
+name: Feature Request
+description: Suggest an idea you have in mind for this project
+title: "[Feature Request]: "
+labels: ["enhancement"]
+assignees:
+  - weiameili
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to suggest an idea for this project!
+
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: What's the Problem?
+      description: If your feature request is related to a problem, describe it clearly.
+      placeholder: "Eg: I'm always frustrated when [...]"
+
+  - type: textarea
+    id: feature-idea
+    attributes:
+      label: What's your solution or idea?
+      description: "A clear and concise description of what you want to happen"
+      placeholder: "Eg: I would like Pensela to ..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: feature-alternatives
+    attributes:
+      label: Alternatives Considered
+      description: "Describe alternatives you've considered"
+      placeholder: "Eg: I have considered ... as an alternative to this issue"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: app-version
+    attributes:
+      label: App Version
+      description: "What version of Pensela are you running?"
+      options:
+        - Compiled from source
+        - v1.2.3
+        - v1.1.3
+        - v1.1.2
+        - v1.1.1
+        - v1.1.0
+        - v1.0.0
+    validations:
+      required: true
+
+  - type: input
+    id: os-version
+    attributes:
+      label: OS Version
+      description: "The version and build of the Operating System on which you are running this application"
+      placeholder: "Eg: Windows 10 2004 Build 19042 / MacOS Big Sur 11.2 / Ubuntu 20.04 LTS"
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: "Add any other comment or screenshots about the feature request here."
+      placeholder: "Any additional context or screenshots"

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,45 @@
+## Pre-PR Checks
+<!--
+Have you:
+-->
+- [ ] Tested it locally on my computer/server.
+- [ ] Made sure this works.
+- [ ] Added comments in hard-to-understand places.
+- [ ] Made sure the CI has successfully finished without issues.
+
+***
+## Changes
+<!--List the changes you have made in this PR with bullet points( use this: `*`) and fill the checklist below.
+Eg:
+* Fixed this
+* Added this
+* Removed old dependencies, etc.
+-->
+<!--
+Add here
+-->
+*
+
+***
+### Type of change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update(WIP)
+- [ ] Breaking change
+- [ ] Other(list them below)
+<!--
+List the type of change _not_ listed here, ie. Grammatical error fix, etc.
+-->
+***
+### Does this fix a bug?
+- [ ] Yes
+- [ ] No
+
+<!--
+If yes, fill this below:
+-->
+Fixes #(issue)
+
+<!--Replace (issue) with the issue number ie. 52 (or) 23 (or) 47, etc.
+DO NOT, under any circumstances, remove the hashtag given there. This helps up to visit the issue from this PR.
+-->

.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build_windows_and_mac:
+
+    strategy:
+      matrix:
+        os: [windows-latest, macos-latest]
+        node-version: [14.x, 16.x]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js environment
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Cache Dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ matrix.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build:single
+
+  build_linux:
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x]
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js environment
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Cache Dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ubuntu-latest-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Install libarchive-tools
+        run: sudo apt-get install -y libarchive-tools
+
+      - name: Build
+        run: npm run build:single

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing to Transcriptase
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## We Develop with Github
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit code changes, your submissions are understood to be under the same <!--[MIT License](http://choosealicense.com/licenses/mit/)--> that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/weiameili/Pensela/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/weiameili/Pensela/issues/new); it's that easy!
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## Use a Consistent Coding Style
+
+* 2 spaces for indentation rather than tabs
+
+## License
+By contributing, you agree that your contributions will be licensed under its license <!--MIT License-->.

LICENSE

@@ -0,0 +1,6 @@
+ISC License (ISC)
+Copyright 2021 weiameili
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package.json

@@ -6,6 +6,7 @@
   "scripts": {
     "start": "electron .",
     "build": "electron-builder build -wl --publish never --config ./electron-builder.json",
+	"build:single": "electron-builder build --publish never --config ./electron-builder.json",
     "deploy": "electron-builder build -wl --publish always --config ./electron-builder.json",
     "_private:build:macos": "electron-builder build -m --publish never --config ./electron-builder.json"
   },