Skip to content

Commit 962e1b1

Browse files
Update README.md
Signed-off-by: Max Barrett <maximilliangroup@gmail.com>
1 parent e053d6c commit 962e1b1

1 file changed

Lines changed: 87 additions & 2 deletions

File tree

README.md

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,88 @@
1-
# SPARXSTAR WordPress Plugin Starter
1+
# SPARXSTAR™ Starter - A WordPress Plugin Template
2+
**by Starisian Technologies**
23

3-
A template repository for building WordPress plugins that follow Starisian coding conventions and SPARXSTAR deployment needs.
4+
A template repository for building WordPress plugins that follows WordPress coding guidelines and Starisian Technologies SPARXSTAR™ deployment needs.
5+
6+
![GitHub CI](https://github.com/dwyl/auth_plug/actions/workflows/ci.yml/badge.svg)
7+
8+
## SPARXSTAR Starter Master Blueprint
9+
10+
11+
### 1) Top-level docs (trust, clarity, compliance)
12+
13+
* **README.md**: Purpose, scope, supported stacks (WordPress/PHP 8.2+, Node LTS), how to use this template, and when to fork vs. extend.
14+
* **ARCHITECTURE.md**: System boundaries, module layout, data flow, threat model overview, and performance expectations.
15+
* **CONTRIBUTING.md**: Branch strategy, commit style (Conventional Commits), review criteria, required checks.
16+
* **CODE\_OF\_CONDUCT.md**: Behavior standards.
17+
* **SECURITY.md**: How to report vulnerabilities, triage SLA, disclosure policy.
18+
* **LICENSE.md**: Starisian proprietary license (San Diego, CA jurisdiction) with notes for downstream dual-licensing when applicable.
19+
* **ETHICS.md**: Org-wide ethical principles (AI responsibility, community impact).
20+
* **CULTURAL\_GUIDELINES.md**: Inclusive language, localization expectations, content sensitivity guardrails.
21+
* **ROADMAP.md**: Milestones and decision checkpoints.
22+
* **DECISIONS.md**: Architecture Decision Records (ADR log).
23+
* **RELEASE\_NOTES.md / CHANGELOG.md**: Versioned change log and human-readable highlights.
24+
* **SUPPORT.md / MAINTAINERS.md**: Where to get help; owners and escalation.
25+
26+
### 2) Repo hygiene & configuration
27+
28+
* **.editorconfig**, **.gitattributes**, **.gitignore** tuned for PHP/JS/WordPress, audio/media, logs, build artifacts.
29+
* **CODEOWNERS**: Paths mapped to teams (security, infra, web, data).
30+
* **example.env** (+ notes on secret management), **/docs/** for expanded guides, **/templates/** for reusable issue/PR snippets and boilerplate copy.
31+
32+
### 3) Linting, formatting, and quality gates
33+
34+
* **JavaScript/TypeScript**: .eslintrc.\*, .eslintignore with a modern ruleset and plugin notes; **Prettier** via .prettierrc, .prettierignore.
35+
* **Styles**: .stylelintrc.\*, .stylelintignore (CSS/SCSS).
36+
* **PHP**: phpcs.xml (PSR-12 + WordPress rules alignment), phpstan.neon(.dist) with baseline policy.
37+
* **Markdown**: .markdownlint.json for docs quality.
38+
* **Git hooks**: Husky + lint-staged (pre-commit: ESLint/Stylelint/Prettier/PHPCS; pre-push: tests/analyzers).
39+
* **Commit policy**: commitlint.config.\*, czrc for Conventional Commits.
40+
41+
### 4) Testing & analysis
42+
43+
* **PHPUnit**: phpunit.xml.dist, /tests/phpunit/ (bootstrap, fixtures, integration notes).
44+
* **JS tests** (optional): Jest/Vitest config and /tests/js/.
45+
* **Coverage**: Documented thresholds; LCOV/Clover output paths; how CI enforces minimums.
46+
* **Static analysis**: PHPStan levels, ESLint strictness tiers, Stylelint rules; guidance on suppressions and ADRs.
47+
48+
### 5) CI/CD (GitHub-first, GitLab-ready)
49+
50+
* **GitHub Actions** (.github/workflows/):
51+
* ci.yml: matrix for PHP versions and Node LTS; jobs for PHPCS, PHPStan, PHPUnit, ESLint, Stylelint, Markdownlint, coverage upload.
52+
* lint-only.yml: fast PR feedback.
53+
* security.yml: Composer audit, npm audit, secret scanning, Dependabot triage.
54+
* release.yml: tagged releases, changelog build, artifact packaging.
55+
* **Dependabot**: .github/dependabot.yml for Composer, npm, Actions.
56+
* **GitLab mirrors** (if needed): .gitlab-ci.yml stages (lint, test, build, security, release) and **gl-codequality.yml** integration for MR widgets.
57+
58+
### 6) Supply chain & legal guardrails
59+
60+
* **Lockfiles required**: composer.lock, package-lock.json or pnpm-lock.yaml.
61+
* **License scanning**: Policy note (e.g., allowed/denied licenses) and CI step placeholder.
62+
* **Provenance/SLSA note**: Where to add provenance when relevant.
63+
* **Third-party notices**: THIRD\_PARTY\_LICENSES.md guidance.
64+
65+
### 7) Product scaffolding (descriptive only)
66+
67+
* **/src/**: Core application/plugin/library structure (PSR-4 namespaces, layered architecture).
68+
* **/assets/**: Logos, UI references with usage and licensing notes.
69+
* **/schemas/**: JSON/YAML for shared data contracts (e.g., content metadata).
70+
* **/data/**: Small synthetic sample sets for tests and docs.
71+
* **/examples/**: Narrative examples of intended usage; no production code.
72+
* **/templates/**: Starter blueprints (e.g., WP plugin skeleton, REST endpoint outline, content model outline).
73+
74+
### 8) Operations & environments
75+
76+
* **LOCAL\_DEVELOPMENT.md**: Required tool versions, make/npx scripts, Docker guidance (if used).
77+
* **RELEASE\_PROCESS.md**: Versioning policy, tag naming, backport rules.
78+
* **INCIDENTS.md**: Light-weight postmortem template and severity guide.
79+
80+
### 9) SPARXSTAR Profile (uses the Starisian core as-is)
81+
82+
* **/profiles/sparxstar/PROFILE.md**: What to keep “as-is,” environment expectations (WordPress multisite, PHP-FPM, Cloudflare), performance SLO notes.
83+
* **/profiles/sparxstar/QUALITY-GATES.md**: Min coverage thresholds, PHPCS standards, JS rules strictness.
84+
* **/profiles/sparxstar/CI-NOTES.md**: Which workflows are required, required status checks before merge.
85+
* **/profiles/sparxstar/SECURITY-ADDENDA.md**: Any SPARXSTAR-specific hardening or disclosure variations.
486

587
## Supported Stack
688
- WordPress 6.4+
@@ -18,3 +100,6 @@ A template repository for building WordPress plugins that follow Starisian codin
18100
- **Extend** by importing as a subtree if you need to keep upstream changes.
19101

20102
For architecture details see [ARCHITECTURE.md](ARCHITECTURE.md). Contribution guidelines live in [CONTRIBUTING.md](CONTRIBUTING.md).
103+
104+
<sub>Copyright ©2025 Starisian Technologies™. All rights reserved.
105+
[SPARXSTAR](https://sparxstar.com)™ is a trademark of [MaximillianGroup](https://maximilliangroup.us)™.</sub>

0 commit comments

Comments
 (0)