Skip to content

Commit

Permalink
feat: shellcheck and repo update
Browse files Browse the repository at this point in the history
Added shellcheck to test the `dotme` script. Added the GPG/SSH key
from my yubikey. Updated the repo to be more current.
  • Loading branch information
kyau committed May 25, 2023
1 parent 9a3e521 commit 2fb58e2
Show file tree
Hide file tree
Showing 15 changed files with 344 additions and 11 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* kyau
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: kyau
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/01_BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: "\U0001F41B Bug Report"
about: "If something isn't working as expected \U0001F914."
title: ''
labels: 'i: bug, i: needs triage'
assignees: ''

---

## Bug Report

### Environment
| Hardware | Model |
| ----------------| -------------------------- |
| Platform | *Desktop, Laptop, or Tablet* |
| CPU | |
| GPU | |
| HDD | *Disk, SSD, or NVME* |
| Windows Version | *Pro N* |
| Windows Build | *22621.169* |

### What is the expected behavior?

### What is the actual behavior?

### Additional information to reproduce the issue?

Add any other content about the problem here. If applicable, add screenshots to help explain.

### Possible Solution?

### If the bug is confirmed, would you be willing to submit a PR?

Yes / No *(Help can be provided if you need assistance submitting a PR)*
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/02_FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "\U0001F680 Feature Request"
about: "I have a suggestion (and may want to implement it \U0001F642)!"
title: ''
labels: 'i: enhancement, i: needs triage'
assignees: ''

---

## Feature Request

### What exactly are you trying to accomplish?

*Context matters. What are you trying to do? Is this something you currently cannot do?*

### Is your feature request related to an issue, problem or flaw?

*Clear and concise description of what the problem is.*

### Proposed Solution

*Clear and concise description of what you want to happen. Add any considered drawbacks.*

### Alternative Solutions

*Clear and concise description of alternative solutions or methods you have considered. Is the alternative considerable?*

### If the feature request is approved, would you be willing to submit a PR?

Yes / No *(Help can be provided if you need assistance submitting a PR)*
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: ❓ Help and Support Discord Channel
url: https://discord.gg/DSvUNYm
about: Please ask and answer questions here. 📮
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Summary of the Pull Request

# References

# Gitleaks Output

*Replace this text with the output of `gitleaks detect -v` wrapped in code block.*

# PR Checklist

## All Submissions:

* [ ] Have you followed the guidelines in our Contributing document?
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
* [ ] Does your submission ensure overall functionality?
* [ ] Have you lint your code locally prior to submission?
* [ ] Have you run your code through `zricethezav/gitleaks` prior to submission?

## Changes to Core Features:

* [ ] Have you added an explanation of what your changes do and why you would like us to include them?
* [ ] Have you properly tested your changes?
* [ ] Have you successfully ran through a local test installation with your changes?

# Additional Comments
File renamed without changes
File renamed without changes
20 changes: 20 additions & 0 deletions .github/workflows/shellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: CI

on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
workflow_dispatch:

jobs:
shellcheck:
name: Shellcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
additional_files: 'dotme'
ignore_paths: bin/** config/** tmux/**
134 changes: 134 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
git+abuse@kyaulabs.com.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing

Thanks for taking an interest in this project. We want to make contributing to this project as easy and transparent as possible, whether it is:

* 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. Discussion and general support is typically done through Discord and/or Email.

## We Use [Git Flow](https://www.gitkraken.com/learn/git/git-flow)

All code changes happen through pull requests and are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your own branch off of the `develop` branch.
2. Name your branch `feature/<name>-<hash>-<desc>` where:
* `<name>` is your Github username
* `<hash>` is equal to `printf "%x\n" (date +"%H%M%S")`
* `<desc>` is a short description using hyphen as a separator
3. If you have added code that should be tested, add tests.
4. If you have changes APIs, update the documentation.
5. Ensure it passes whatever tests are being used.
6. Make sure your code lints.
7. Issue the pull request!


## Reporting Bugs / Feature Requests

We use Github issues to track public bugs and feature requests. Report a bug/feature by [opening a new issue](/../../issues); it is that easy!

## Contributions & Software Licensing

In short, when you submit code changes, your submissions are understood to be under the same [license](LICENSE) that covers the project itself. If you have a concern about this, please refrain from submitting a PR and contact a maintainer directly.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
$KYAULabs: README.md,v 1.1.0 2022/01/10 01:42:29 kyau Exp $
# dotfiles
[https://kyau.net/](https://kyau.net/)

[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-2.1-4baaaa.svg?logo=open-source-initiative&logoColor=4baaaa)](CODE_OF_CONDUCT.md) &nbsp; [![GitHub](https://img.shields.io/github/license/kyaulabs/template?logo=creativecommons)](LICENSE) &nbsp; [![Gitleaks](https://img.shields.io/badge/protected%20by-gitleaks-blue?logo=git&logoColor=seagreen&color=seagreen)](https://github.com/zricethezav/gitleaks) &nbsp; [![Discord](https://img.shields.io/discord/88713030895943680?logo=discord&color=blue&logoColor=white)](https://discord.gg/DSvUNYm)

* [About](#about)
* [Usage](#usage)
* [Screenshots](#screenshots)
* [Attribution](#attribution)

## About
*"Simplicity is the ultimate sophistication." - Leonardo da Vinci*

### dotfiles
These are the dotfiles that I use while running Arch Linux on my desktop and laptop. Originally to keep a backup that was easily accessible. I have since added tools to automate the process of installing all of the default packages I use and setting up the proper symbolic links for all of the files in this repository. If one were to use these files, it is highly recommended you fork the repository and thoroughly look over its contents to make sure all of the settings are to your liking. Many will need to be changed as they are setup with my own personal information.

### usage
```bash
## Usage
```
Usage: ./dotme [OPTION]...
Initiate the user environment. Does nothing with no OPTION.
-i install user packages (.pkg-<profile>)
Expand All @@ -16,12 +24,12 @@ Initiate the user environment. Does nothing with no OPTION.
-h display this help and exit
```

### screenshots
![Login MOTD](https://raw.githubusercontent.com/kyau/dotfiles/master/ss1.png "Login MOTD")
## Screenshots
![Login MOTD](.github/media/ss1.png "Login MOTD")

![vim](https://raw.githubusercontent.com/kyau/dotfiles/master/ss2.png "vim")
![vim](.github/media/ss2.png "vim")

### attribution
## Attribution
* [Agave](https://github.com/blobject/agave) - Agave, current font
* [Starship](https://starship.rs/) - customizable cross-shell prompt
* [http://bohoomil.deviantart.com/](http://bohoomil.deviantart.com/) - Xresources color scheme modified from Euphrasia (link broken)
Expand Down
37 changes: 37 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Security Policy

This document outlines security procedures and general policies.

* [Supported Version](#supported-versions)
* [Reporting a Bug](#reporting-a-bug)
* [Disclosure Policy](#disclosure-policy)
* [Comments](#comments)

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| 1.0.0 | :white_check_mark: |
| < 1.0.0 | :x: |

## Reporting a Bug

The team and community take all security bugs seriously. Thank you for improving the security. We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.

Report security bugs by emailing the lead maintainer at git@kyaulabs.com.

The lead maintainer will acknowledge your email within 48 hours, and will send a more detailed response within 48 hours indicating the next steps in handling your report. After the initial reply to your report, the security team will endeavor to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

Report security bugs in third-party modules/packages to the person or team maintaining the module and/or package.

## Disclosure Policy

When the security team receives a security bug report, they will assign it to a primary handler. This person will coordinate the fix and release process, involving the following steps:

* Confirm the problem and determine the affected versions.
* Audit code to find any potential similar problems.
* Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible.

## Commments

If you have suggestions on how this process could be improved please submit a pull request.
6 changes: 3 additions & 3 deletions config/polybar/tempcores.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Get information from cores temp thanks to sensors
rawData=$( sensors | grep Core | awk '{print substr($3, 2, length($3)-5)}' )
tempCore=($rawData)
tempCore=( "$rawData" )

# Define constants :
degree="°C"
Expand All @@ -27,7 +27,7 @@ do
total=$(( ${tempCore[$iCore]} + total ));
done

sum=$(( $total/${#tempCore[*]} ))
sum=$(( total/${#tempCore[*]} ))

for iTemp in ${!temperaturesValues[*]}
do
Expand All @@ -40,4 +40,4 @@ do
fi
done

echo $finalEcho
echo "$finalEcho"
Loading

0 comments on commit 2fb58e2

Please sign in to comment.