Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FLOW :: Code Quality Assurance #12

Closed
5 of 16 tasks
iPoetDev opened this issue Jul 11, 2023 · 2 comments
Closed
5 of 16 tasks

FLOW :: Code Quality Assurance #12

iPoetDev opened this issue Jul 11, 2023 · 2 comments
Assignees
@iPoetDev
Labels
Quality: Check Quality: Clean Quality: Code Quality: Format Quality: Leeks Quality: Lint Quality: Robust Quality: Secrets Quality: Style Quality: Valid #Quality Activity: Quality, Reliability, Assurance | Readme Header Readme: 13 Quality Assurance, Quality, Report, Validation, Format Checks, Security
Milestone
REPOSITORY: Setup...

Comments

@iPoetDev
Copy link
Owner

iPoetDev commented Jul 11, 2023 •
edited
Loading

FLOW: Code Checks, Code Quality, Code Valid, Code Secrets

Document: Developer Practice | Industry Practice | Developer Skills | Industry Conventions

  • Criteria:
  • Complete? ❓✔

Repository


Project Root

- /dash-and-do-github
  - /.github
  - /docs
  - .gitleaksignore                                             # Optional ignore
  - CODEOWNERS                                                  # Common Standards Code & PR ownership
  - .editorconfig                                               # EditorConfig: IDE Code and Whitespace Quality
  - .gitignore                                                  # Git: Exclude Files to Remote & Secrets 
  - .eslintrc.js                                                # ESLint: JS Quality
  - .stylelintrc.json                                           # StyleLint: CSS Quality
  - package.json                                                # NPM: Dependencies Config
  - package.json.lock                                           # NPM: Packaging
  - README.md                                                   # Readme
  - .prettierignore                                             # Prettier: Ignore files
  - .gitleaks.toml                                                # Gitleaks config
  - pyproject.toml                                              # Python Libraries config, inc Ruff for Linting
  - .htmlhintrc                                                 # HTMLHint: HTML Quality
  - AUTHORS
  - CITATION
  - LICENSE                                                     # Licence
  - .pre-commit-config.yml                                      # Pre-commit Hooks
  - .prettier.yaml                                              # Prettier: Code Formatting

Flow

  • Update the repo diagram
  • Tag this repo in each relevant commit, => show up in the issue history
  • Complete this before close as a final report

1. Linting:

Developer Experience, Code Quality, DX Tooling, IDE Integrations, CLI Checks

  • Prettier - Code Style & Formating -> .prettierrc.yaml
  • EditorConfig - IDE's Whitespace, Code Format/Style -> .editorconfig
  • HTMLHint - HTML Correctness -> .htmlhintrc
  • Stylelinerc - CSS Correctness -> stylelintrc.json
    • Dependencies: Shared Configs -> package.json
    • Uses pre-commits: See Issue | Doc:
  • Eslint - JavaScript Correctness -> eslintrc.js
    • Dependencies: Shared Configs -> package.json
    • Uses pre-commits: See Issue | Doc:
  • Ruff - Python Correctness -> pyproject.toml
    • Uses pre-commits
  • GitIgnore - Secrets Filter & Exclusion -> .gitignore
    • Uses pre-commits: See Issue | Doc:

IDE Checks | Rules

Highlight Key Rules | Workflow

  • IDE: Web Storm, PyCharm
  1. Prettier:
  2. EditorConfig
  • Formats on Save,
  • Checks on on Pre-commit
1. .
2. .

HTML Checks | Rules

Highlight Key Rules | Workflow

1. .
2. .

CSS Checks | Rules

Highlight Key Rules | Workflow

1. .
2. .

JavaScript | Rules

Highlight Key Rules | Workflow

1. .
2. .

Python | Rules

Highlight Key Rules | Workflow

1. .
2. .

Secrets | Rules

Highlight Key Rules | Workflow

1. .
2. .

Sources

Docs

  • .

Guides

  • .
@iPoetDev iPoetDev self-assigned this Jul 11, 2023
@iPoetDev iPoetDev mentioned this issue Jul 11, 2023
Open
64 tasks
iPoetDev added a commit that referenced this issue Jul 12, 2023
@iPoetDev
proj + config (document, quality): Code Quality/Assurance
0c4a09d 
Issue: #12 FLOW :: Code Quality Assurance
Intent: IDE Whitespace Code Style, Formats, Robusts
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-12 v00.00.001:01
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formaters
  - docs: editorconfig.md (docs/integration)
  - docs: prettier.md (docs/integration)
  - config: .editorconfig
  - config: .pretterrc.yaml/.prettierignore
- update:
  - .
- note:
  - Init Code Quality & Standards for Project, & IDE integration

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 12, 2023
@iPoetDev
proj + config (document, quality): Code Quality/Assurance (patch ii)
cabd7a8 
Issue: #12 FLOW :: Code Quality Assurance
Intent: IDE Whitespace Code Style, Formats, Robusts
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-12 v00.00.001:01
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formaters
  - docs: editorconfig.md (docs/integration)
  - docs: prettier.md (docs/integration)
  - config: .editorconfig
  - config: .pretterrc.yaml/.prettierignore
- update:
  - .
- note:
  - Init Code Quality & Standards for Project, & IDE integration

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 12, 2023
@iPoetDev
proj + config (document, quality): CSS Code Quality/Assurance (patch i)
2e24992 
Issue: #12 FLOW :: Code Quality Assurance
Intent: CSS Style Errors and Conventions
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-12 v00.00.001:03
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
  - docs: stylelint.md (docs/integration)
  - config: .stylelintrc.json
- update:
  - .
- note:
  - Init Code Quality & Standards for CSS & Stylesheet

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 12, 2023
@iPoetDev
proj + config (document, quality): CSS Code Quality/Assurance (patch i)
b3952a4 
Issue: #12 FLOW :: Code Quality Assurance

Intent: CSS Style Errors and Conventions & Superlint CI
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-12 v00.00.001:03
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
  - docs: stylelint.md (docs/integration)
  - config: .stylelintrc.json (./)
  - ci config: superlinter.yml (.github/workflow)
- update:
  - .
- note:
  - Init Code Quality & Standards for CSS & Stylesheet

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 12, 2023
@iPoetDev
proj + config (document, quality): HTML Code Quality/Assurance (patch i)
c4ffc1a 
Issue: #12 FLOW :: Code Quality Assurance

Intent: HTML Hint Errors and Conventions & Superlint CI
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-12 v00.00.001:03
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
  - docs:    htmlhint.md (docs/integration)
  - config: .htmlhintrc
- update:
  - .
- note:
  - Init Code Quality & Standards for CSS & Stylesheet

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 13, 2023
@iPoetDev
proj + config (document, quality): JavaScript Code Quality/Assurance …
afd545c 
…(patch i)

Issue: #12 FLOW :: Code Quality Assurance

Intent: ESLint, StandardJS code quality
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-13 v00.00.001:01
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
  - docs:    eslint.md (docs/integration)
  - docs:    standardjs.md (docs/integration)
  - config: .eslintrc
- update:
  - .
- note:
  - Init Code Quality & Standards for JavaScript
  - standard is a local cli terminal usecase

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 13, 2023
@iPoetDev
proj + config (document, quality): JavaScript Code Quality/Assurance …
0b70278 
…(patch i)

Issue: #12 FLOW :: Code Quality Assurance

Intent: ESLint, StandardJS code quality
Tag: project,repo,documentation,configuration,checks,quality
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-13 v00.00.001:01
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
  - docs:    eslint.md (docs/integration)
  - docs:    standardjs.md (docs/integration)
  - config: .eslintrc
- update:
  - .
- note:
  - Init Code Quality & Standards for JavaScript
  - standard is a local cli terminal usecase

 ---
 Agilelog:
 - epic: REPOSITORY: Setup | Configuration | Maintenance

 ---
 AssesmentLog
 - pass: LO-6.2
 - merit:
 - distinct: Clean Code, Code Standards, Indentation, Blank Lines,
   Code Validation,
iPoetDev added a commit that referenced this issue Jul 13, 2023
@iPoetDev
proj + config (document, quality): HTML Validation scripts (patch i)
497e257 
Issue: #12 FLOW :: Code Quality Assurance

Intent: HTML Validation
Tag: project,repo,documentation,configuration,validation
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-13 v00.00.001:04
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
   - docs:   w3c-html-validator & HTML W3C Validation.md (docs/integration)
   - config: package.json/scripts + CLI
- update:
   - .
- note:
   - Scope: Local pre-commit local script for validation
---
Agilelog:
- epic: REPOSITORY: Setup | Configuration | Maintenance

---
AssesmentLog
- pass: LO-6.2
- merit:
- distinct: Clean Code, Code Standards, Indentation, Blank Lines,
  Code Validation,
iPoetDev added a commit that referenced this issue Jul 13, 2023
@iPoetDev
proj + config (document, quality): CSS Stylelint plugin (patch i)
899daf9 
Issue: #12 FLOW :: Code Quality Assurance

Intent: CSS Validation (but remember W3C CSS Jigsaw validation)
Tag: project,repo,documentation,configuration,validation
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-13 v00.00.001:05
- repo: package.json/package-lock.json (npm)
- add: Docs: Describe/inventory Quality Linter/Formatters
   - docs:   w3c-html-validator & HTML W3C Validation.md (docs/integration)
   - config: package.json/scripts + CLI
- update:
   - .
- note:
   - Scope: Local pre-commit local script for validation
---
Agilelog:
- epic: REPOSITORY: Setup | Configuration | Maintenance

---
AssesmentLog
- pass: LO-6.2
- merit:
- distinct: Clean Code, Code Standards, Indentation, Blank Lines,
  Code Validation,
@iPoetDev iPoetDev mentioned this issue Jul 13, 2023
Closed
10 tasks
iPoetDev added a commit that referenced this issue Jul 14, 2023
@iPoetDev
proj + config (document, secrets): GitLeaks & Secrets
6ee5eef 
Issue: #12 FLOW :: Code Quality Assurance

Intent: Secrets Local, Pre-commit, GitHub Action, Detect & Protect
Tag: project,repo,documentation,configuration,validation
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-14 v00.00.001:01
- add: Docs: Describe/inventory Quality Linter/Formatters
   - docs:   gitleaks.md & Badge
   - config: gitleaks.toml, .gitleakignore
   - ci:     gitleaks.yml (defined, not committed yet)
- update:
   - .
- note:
   - The CI is not deployed as not using CI (yet)
   - Should default to default toml, as does not have custom yet
   - testing is due
---
Agilelog:
- epic: REPOSITORY: Setup | Configuration | Maintenance

---
AssesmentLog
- pass: LO-5.2, LO-6.4
- merit:
- distinct: Clean Code, Code Standards, Secrets
  Code Validation, Security features and practice are evidenced, Passwords and secret keys are never committed to the repository
@iPoetDev
Copy link
Owner Author

Added to the repo diagram

  • Gitleaks, Codeowners, Author, Citation

iPoetDev added a commit that referenced this issue Jul 14, 2023
@iPoetDev
proj + chore (document, quality): Config files updates, line endings …
d122d37 
…> `lf`

Issue: #12 FLOW :: Code Quality Assurance

Intent:
Tag: project,repo,documentation,configuration,validation
Sprint: 01: Ends 23-7-14
Changelog: 2023-07-14 v00.00.001:02
- add: Docs: Describe/inventory Quality Linter/Formatters
- update: Config updates
   - config: .eslint, .gitignore, .pre-commit-.., .pyproject.toml
   - Common Files:  Licence, Readme
- note:
   -
---
Agilelog:
- epic: REPOSITORY: Setup | Configuration | Maintenance

---
AssesmentLog
- pass: 6.4
- merit:
- distinct: Clean Code, Code Standards, Secrets
  Code Validation,
@iPoetDev
Copy link
Owner Author

iPoetDev commented Jul 14, 2023 •
edited
Loading

  • Linked Related
  • Document Final Repository Config

@zube zube bot removed the [zube]: Archives label Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iPoetDev iPoetDev

Labels
Quality: Check Quality: Clean Quality: Code Quality: Format Quality: Leeks Quality: Lint Quality: Robust Quality: Secrets Quality: Style Quality: Valid #Quality Activity: Quality, Reliability, Assurance | Readme Header Readme: 13 Quality Assurance, Quality, Report, Validation, Format Checks, Security
Projects
01 DASH & DO: Repository Management
Status: Done
Milestone
REPOSITORY: Setup | Configuration | M...
Development

No branches or pull requests
1 participant
@iPoetDev