feat(Actions, README): added ruff python linter and changed readme

This commit is contained in:
darkicewolf50 2024-12-21 16:07:34 -07:00
parent e3fadaf5ce
commit 79c099bf43
2 changed files with 52 additions and 0 deletions

45
.github/workflows/Actions.yaml vendored Normal file
View File

@ -0,0 +1,45 @@
# name of the workflow.
# this is optional.
name: PyLint
# events that will trigger this workflow.
# here, we only have "pull_request", so the workflow will run
# whenever we create a pull request.
# other examples: [push] and [pull_request, push]
on:
pull_request:
push:
branches:
- main
# each workflow must have at least one job.
# jobs run in parallel by default (we can change that).
# each job groups together a series of steps to accomplish a purpose.
jobs:
# name of the job
ruffLint:
# the platform or OS that the workflow will run on.
runs-on: ubuntu-latest
# series of steps to finish the job.
steps:
# name of the step.
# steps run sequentially.
# this is optionale
- name: checkout
# each step can either have "uses" or "run".
# "uses" run an action written somewhere other than this workflow .
# usually from the community.
# this action checks out the repo code to the runner (instance)
# running the action
uses: actions/checkout@v3
# another step.
# this step runs a bash (Ubuntu's default shell) command
- name: install ruff
run: pip install ruff
- name: Lint
run: ruff check ./*/*.py --ignore E402

View File

@ -10,3 +10,10 @@ Other Requirement
Python 3.10.2 or higher can be found at
https://www.python.org/downloads/
please select the version for your computer
# REDO COMPLETELY
ONLY USE IDEAS FROM THIS
NEW Standards can be found in W - Software