Unit testing. README.md. GitHub items. Version Bump (#18)

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+    * Using welcoming and inclusive language
+    * Being respectful of differing viewpoints and experiences
+    * Gracefully accepting constructive criticism
+    * Focusing on what is best for the community
+    * Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+    * The use of sexualized language or imagery and unwelcome sexual attention or
+    advances
+    * Trolling, insulting/derogatory comments, and personal or political attacks
+    * Public or private harassment
+    * Publishing others' private information, such as a physical or electronic
+    address, without explicit permission
+    * Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+
+[homepage]: https://www.contributor-covenant.org

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,91 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - ismet55555
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        Any information you provide will help a lot!
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: How can we reproduce this?
+      placeholder: |
+        "Example: I just ran `bieye --help`, and it ported me into the matrix!"
+    validations:
+      required: true
+
+  - type: textarea
+    id: debug-output
+    attributes:
+      label: RUST_LOG=debug Output
+      description: Enter the output when running with prefix of RUST_LOG=debug
+      placeholder: >
+        Example: RUST_LOG=debug bieye "hello"
+        Paste the output here.
+        If needed remove any sensitive information.
+    validations:
+      required: false
+
+  - type: input
+    id: version
+    attributes:
+      label: Version of `bieye`
+      description: Enter the version you were using
+      placeholder: "Example: 0.0.57"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: terminal-type
+    attributes:
+      label: What type of terminal and/or terminal multiplexer were you using?
+      options:
+        - sh
+        - bash
+        - zsh
+        - fsh
+        - PowerShell
+        - Other
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: operating-systems
+    attributes:
+      label: Which operating systems were you using when this happened?
+      description: You may select more than one
+      options:
+        - label: macOS
+        - label: Windows
+        - label: Linux
+        - label: Other
+        - label: I don't know
+
+  - type: dropdown
+    id: day-check
+    attributes:
+      label: How is your day going?
+      options:
+        - Amazing!
+        - Pretty good
+        - Not bad
+        - Meh
+        - Terrible
+        - Ugh, don't remind me
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,55 @@
+name: Feature Request
+description: Suggest an idea or feature for this project
+title: "[Feature-Request]: "
+labels: ["feature-request"]
+assignees:
+  - ismet55555
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+        Any input or ideas are greatly appreciated and taken seriously.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature you would like to see
+      description: A clear and concise description of what you want to happen
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives/workarounds you have considered
+      description: A clear and concise description of any alternative solutions or features you've considered
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: operating-systems
+    attributes:
+      label: Which operating systems are you using?
+      description: You may select more than one
+      options:
+        - label: macOS
+        - label: Windows
+        - label: Linux
+        - label: Other
+        - label: I don't know
+
+  - type: dropdown
+    id: day-check
+    attributes:
+      label: How is your day going?
+      options:
+        - Amazing!
+        - Pretty good
+        - Not bad
+        - Meh
+        - Terrible
+        - Ugh, don't remind me
+    validations:
+      required: false

.github/pull_request_template.md

@@ -0,0 +1,44 @@
+## Change Motivation
+
+_(A very brief summary on why you made these changes)_
+
+...
+
+---
+
+## Describe the Changes Made
+
+_(A very brief summary on what changes you made)_
+
+...
+
+---
+
+## Change Type
+
+_(Check any that apply)_
+
+- [ ] Bug Fix
+- [ ] New Feature
+- [ ] Code Refactoring
+- [ ] Documentation
+- [ ] Formatting
+- [ ] Automation
+- [ ] Unit Tests
+- [ ] Other
+
+---
+
+## How Has This Been Tested?
+
+_(Please describe the tests/commands that you ran to verify your changes)_
+
+...
+
+---
+
+# Checklist
+
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation (if applicable)
+- [ ] My changes generate no new warnings

.github/workflows/release_github.yml

@@ -0,0 +1,91 @@
+# ---
+# name: Release to GitHub
+#
+# on:
+#   push:
+#     tags:
+#       - v1.*
+#
+# jobs:
+#   create-release:
+#     name: ${{ matrix.name }}
+#     runs-on: ${{ matrix.os }}
+#     needs: Testing  # Test GitHub Workflow
+#
+#     strategy:
+#       matrix:
+#         os: [ubuntu-latest, macos-latest, windows-latest]
+#         include:
+#           - os: ubuntu-latest
+#             name: Linux Binary 64-Bit
+#             target: x86_64-unknown-linux-musl
+#
+#           - os: macos-latest
+#             name: MacOS Binary 64-Bit
+#             target: x86_64-apple-darwin
+#             target2: aarch64-apple-darwin
+#             env:
+#               MACOSX_DEPLOYMENT_TARGET: 10.7
+#
+#           - os: windows-latest
+#             name: Windows Binary 64-Bit
+#             target: x86_64-pc-windows-msvc
+#
+#     steps:
+#       - name: Check out repository
+#         uses: actions/checkout@v3
+#
+#       - name: Add rustup default target
+#         run: rustup target add ${{ matrix.target }}
+#
+#       - name: Add rustup Apple ARM64 target
+#         if: ${{ matrix.os == 'macos-latest' }}
+#         run: rustup target add ${{ matrix.target2 }}
+#
+#       - name: Build default target in release mode
+#         run: cargo build --release --target ${{ matrix.target }} --locked
+#
+#       - name: Build Apple ARM64 target in release mode
+#         if: ${{ matrix.os == 'macos-latest' }}
+#         run: cargo build --release --target ${{ matrix.target2 }} --locked
+#
+#       - name: Get latest release version number
+#         id: get_version
+#         uses: battila7/get-version-action@v2
+#
+#       - name: Create zip file on Windows
+#         if: ${{ matrix.os == 'windows-latest' }}
+#         run: |
+#           choco install zip
+#           cd target/${{ matrix.target }}/release
+#           zip bieye-${{ steps.get_version.outputs.version }}-${{ matrix.target }}.zip bieye.exe
+#           cd ../../..
+#
+#       - name: Create tar.gz file on macOS
+#         if: ${{ matrix.os == 'macos-latest' }}
+#         run: |
+#           chmod +x target/${{ matrix.target }}/release/bieye
+#           tar -zcf target/${{ matrix.target }}/release/bieye-${{ steps.get_version.outputs.version }}-${{ matrix.target }}.tar.gz -C target/${{ matrix.target }}/release bieye
+#           chmod +x target/${{ matrix.target2 }}/release/bieye
+#           tar -zcf target/${{ matrix.target2 }}/release/bieye-${{ steps.get_version.outputs.version }}-${{ matrix.target2 }}.tar.gz -C target/${{ matrix.target2 }}/release bieye
+#
+#       - name: Create tar.gz file on Linux
+#         if: ${{ matrix.os == 'ubuntu-latest' }}
+#         run: |
+#           chmod +x target/${{ matrix.target }}/release/bieye
+#           tar -zcf target/${{ matrix.target }}/release/bieye-${{ steps.get_version.outputs.version }}-${{ matrix.target }}.tar.gz -C target/${{ matrix.target }}/release bieye
+#
+#       - name: Upload release and assets to GitHub
+#         uses: svenstaro/upload-release-action@v2
+#         with:
+#           repo_token: ${{ secrets.GITHUB_TOKEN }}
+#           tag: ${{ github.ref }}
+#           release_name: bieye ${{ steps.get_version.outputs.version }}
+#           file_glob: true
+#           file: target/*/release/bieye-${{ steps.get_version.outputs.version }}-*.{zip,tar.gz}
+#
+#       - name: Upload release to crates.io
+#         uses: katyo/publish-crates@v2
+#         if: ${{ matrix.os == 'ubuntu-latest' }}
+#         with:
+#           registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/rust.yml

@@ -33,6 +33,11 @@ jobs:
       - name: Cache build artifacts
         uses: swatinem/rust-cache@v2
 
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
       - name: Check terminal type - $TERM
         run: echo $TERM
 
@@ -54,12 +59,15 @@ jobs:
 
       - name: Create code coverage report with cargo-tarpaulin
         uses: actions-rs/[email protected]
-        # if: ${{ matrix.os == 'ubuntu-latest' }}
         with:
           version: '0.19.1'
           args: '--ignore-config --ignore-panics --ignore-tests --exclude-files src/main.rs'
           timeout: 900
 
+      # - name: Upload code coverage report to Codecov
+      #   if: ${{ matrix.os == 'ubuntu-latest' && github.event_name == 'push' }}
+      #   uses: codecov/codecov-action@v3
+
       - name: Check Run
         shell: bash
         run: cargo run -- --help