diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 43c3545..e44cf7f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,15 +1,5 @@ # Code of Conduct -PCCX AI participants are expected to follow the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). +pccxai participants are expected to follow the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). -## Scope - -This applies to all project spaces -- issues, pull requests, discussions, and any project-affiliated communication. - -## Enforcement - -Reports may be sent to k1h6w4@gmail.com. Reports are reviewed with discretion. Maintainers may remove or reject content that violates this Code, and may temporarily or permanently ban contributors as needed. - -## Attribution - -Adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). +Reports may be sent to k1h6w4@gmail.com. Maintainers review reports with discretion and may remove or reject conduct that violates this standard. diff --git a/ISSUE_TEMPLATE/bug.yml b/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..1088f14 --- /dev/null +++ b/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,56 @@ +name: Bug +description: Report a reproducible defect. +title: "[bug] " +labels: ["type:bug", "status:triage"] +body: + - type: input + id: repository + attributes: + label: Repository + description: Repository and path, if known. + placeholder: "pccxai/repo-name, path/to/file" + validations: + required: true + - type: input + id: version + attributes: + label: Version or commit + description: Tag, branch, or commit where the defect was observed. + placeholder: "main at abc1234" + validations: + required: true + - type: textarea + id: observed + attributes: + label: Observed result + description: What happened? + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected result + description: What should have happened? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Reproduction + description: Minimal commands, inputs, or steps. + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: OS, toolchain versions, target board, and other relevant context. + - type: textarea + id: evidence + attributes: + label: Evidence + description: Logs, screenshots, failing checks, or links to run output. diff --git a/ISSUE_TEMPLATE/bug_report.yml b/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 8857694..0000000 --- a/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,54 +0,0 @@ -name: Bug report -description: Report a defect that affects published behaviour, builds, or documentation. -title: "[bug] " -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - Please file a bug report only for issues that affect published behaviour, builds, or documentation. For questions or design discussions, use Discussions instead. - - type: input - id: version - attributes: - label: Affected version or commit - description: Tag, release, or commit SHA where the bug was observed. - placeholder: "v0.1.0 or commit abc1234" - validations: - required: true - - type: textarea - id: actual - attributes: - label: Observed behaviour - description: What happens? - validations: - required: true - - type: textarea - id: expected - attributes: - label: Expected behaviour - description: What did you expect instead? - validations: - required: true - - type: textarea - id: repro - attributes: - label: Steps to reproduce - description: Minimal commands or actions to reproduce. - placeholder: | - 1. ... - 2. ... - 3. ... - validations: - required: true - - type: textarea - id: environment - attributes: - label: Environment - description: OS, toolchain versions, target hardware where relevant. - placeholder: "Ubuntu 24.04, rustc 1.75, KV260, ..." - - type: textarea - id: logs - attributes: - label: Relevant logs or output - description: Paste log excerpts inside a fenced code block. - render: shell diff --git a/ISSUE_TEMPLATE/documentation.yml b/ISSUE_TEMPLATE/documentation.yml deleted file mode 100644 index 3a99c95..0000000 --- a/ISSUE_TEMPLATE/documentation.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Documentation issue -description: Report broken, unclear, or missing documentation. -title: "[docs] " -labels: ["documentation"] -body: - - type: input - id: page - attributes: - label: Page or file - description: Documentation URL or repository path. - placeholder: "https://pccxai.github.io/pccx/... or path/to/file.md" - validations: - required: true - - type: textarea - id: problem - attributes: - label: What is wrong or unclear - validations: - required: true - - type: textarea - id: suggestion - attributes: - label: Suggested fix - description: Optional. A concrete suggestion is welcome but not required. diff --git a/ISSUE_TEMPLATE/evidence.yml b/ISSUE_TEMPLATE/evidence.yml new file mode 100644 index 0000000..ca9da5d --- /dev/null +++ b/ISSUE_TEMPLATE/evidence.yml @@ -0,0 +1,39 @@ +name: Evidence +description: Submit or request evidence for repository claims, release gates, or review decisions. +title: "[evidence] " +labels: ["type:docs", "area:verification", "status:triage"] +body: + - type: input + id: repository + attributes: + label: Repository + description: Repository where the claim, gate, or review decision lives. + placeholder: "pccxai/repo-name" + validations: + required: true + - type: textarea + id: subject + attributes: + label: Subject + description: Claim, release gate, or review decision that needs evidence. + validations: + required: true + - type: textarea + id: evidence + attributes: + label: Evidence state + description: Link the logs, reports, commits, checks, or board records. Say "missing" if evidence is not available yet. + validations: + required: true + - type: textarea + id: limits + attributes: + label: Limits + description: Known gaps, blocked inputs, unsupported scope, or follow-up work. + validations: + required: true + - type: textarea + id: reviewer_notes + attributes: + label: Reviewer notes + description: Optional notes for maintainers. diff --git a/ISSUE_TEMPLATE/feature.yml b/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..e3e3902 --- /dev/null +++ b/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,44 @@ +name: Feature +description: Propose a scoped capability or repository change. +title: "[feature] " +labels: ["type:feature", "status:triage"] +body: + - type: input + id: repository + attributes: + label: Repository + description: Target repository or repositories. + placeholder: "pccxai/repo-name" + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem + description: What concrete problem does this solve? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal + description: Describe the smallest useful change. + validations: + required: true + - type: textarea + id: boundary + attributes: + label: Boundary + description: What is in scope, and what is explicitly out of scope? + validations: + required: true + - type: textarea + id: evidence + attributes: + label: Evidence or references + description: Related issues, design notes, traces, logs, or prior work. + - type: textarea + id: acceptance + attributes: + label: Acceptance checks + description: How should maintainers verify this is done? diff --git a/ISSUE_TEMPLATE/feature_request.yml b/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index aad1462..0000000 --- a/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Feature request -description: Propose new capability or scope expansion. -title: "[feature] " -labels: ["enhancement"] -body: - - type: markdown - attributes: - value: | - For open-ended ideas, consider a Discussion first. Use this form when the proposal is concrete enough to scope into a single change. - - type: textarea - id: motivation - attributes: - label: Motivation - description: What problem does this solve, and for whom? - validations: - required: true - - type: textarea - id: proposal - attributes: - label: Proposed solution - description: How would it work? Diagrams, pseudocode, or interface sketches welcome. - validations: - required: true - - type: textarea - id: alternatives - attributes: - label: Alternatives considered - description: Optional. Other approaches you weighed and why this one is preferred. - - type: textarea - id: scope - attributes: - label: Out of scope - description: Optional. What this proposal explicitly does not cover. diff --git a/ISSUE_TEMPLATE/good_first_issue.yml b/ISSUE_TEMPLATE/good_first_issue.yml deleted file mode 100644 index 36c8ba0..0000000 --- a/ISSUE_TEMPLATE/good_first_issue.yml +++ /dev/null @@ -1,59 +0,0 @@ -name: Good first issue -description: Maintainers — file a contributor-friendly task with explicit scope, expected output, and validation steps. -title: "[good first issue] " -labels: ["good first issue", "help wanted", "status:ready"] -body: - - type: markdown - attributes: - value: | - Use this form **only if you are a maintainer** scoping work for a first-time contributor. New contributors should comment on an existing `good first issue` instead of opening a new one. - - Each section below should be filled in concretely. Vague issues discourage contribution. - - type: textarea - id: goal - attributes: - label: Goal - description: One paragraph. What is the change and why is it useful? - validations: - required: true - - type: textarea - id: scope - attributes: - label: Scope - description: Bullet list of what is in scope. Be explicit about file paths and limits (e.g., "< 60 lines", "single new file"). - placeholder: | - - Edit `path/to/file.md`. - - Add one new section under "Examples". - - Keep the change under 50 lines. - validations: - required: true - - type: textarea - id: expected - attributes: - label: Expected output - description: What deliverable closes this issue? Files added, behaviour changed, links resolving, etc. - placeholder: | - - A pull request that adds `CONTRIBUTING.md` at the repo root. - - Links to org-wide docs work on github.com. - validations: - required: true - - type: textarea - id: validation - attributes: - label: Validation - description: How does the contributor (and reviewer) verify the change is correct? Cite the project's actual checks (e.g. `make strict`, `cargo fmt --check`, `repo-validate`). - placeholder: | - - `make strict` passes with zero warnings. - - `npm run lint` is clean. - - File renders correctly on github.com. - validations: - required: true - - type: textarea - id: pointers - attributes: - label: Pointers - description: Optional. Links to related PRs, similar prior work, or specific files to read first. - - type: markdown - attributes: - value: | - New here? Read the [organisation contributing guide](https://github.com/pccxai/.github/blob/main/CONTRIBUTING.md) before opening a pull request, and feel free to ask in [Discussions](https://github.com/pccxai/pccx/discussions) if anything is unclear. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 846f057..041eae7 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,14 @@ - - ## Summary - - -## Type of change - -- [ ] Bug fix -- [ ] New feature -- [ ] Documentation -- [ ] Refactor / cleanup -- [ ] Build / CI / chore - -## Verification - - - -## Linked issues - - +- -## Engineering checklist +## Evidence State -- [ ] Scope is small and bounded -- [ ] Public interface or boundary is clear -- [ ] Tests/smoke checks were run -- [ ] No overclaim about production readiness, timing closure, KV260 inference, or stable ABI -- [ ] No unrelated repo settings, release, tag, or visibility changes -- [ ] Critical architecture assumptions are stated +Evidence state: -## Notes for reviewer +## Review - +- [ ] Scope is bounded +- [ ] Labels and linked issues are correct +- [ ] Public wording is backed by evidence +- [ ] No unrelated settings, release, tag, or visibility changes diff --git a/SECURITY.md b/SECURITY.md index 9d6e2ba..14f7008 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,31 +1,17 @@ # Security Policy -## Reporting a vulnerability +## Reporting -Please do not file a public issue for security findings. +Do not file public issues for security findings. -Email k1h6w4@gmail.com with: +Send reports to k1h6w4@gmail.com with: -- A description of the issue and the affected repository. -- Steps to reproduce, or a minimal proof of concept. -- The version, commit SHA, or build identifier where the issue was observed. -- Any known mitigations or workarounds. +- Affected repository and commit, tag, or release. +- Reproduction steps or a minimal proof of concept. +- Impact and known workarounds, if any. -## Process - -- Initial acknowledgement: within 7 days. -- Triage and impact assessment: within 30 days. -- Coordinated disclosure window: up to 90 days from acknowledgement, extended only when a fix demonstrably needs more time. - -A fix and advisory are published together once a release with the patch is available. +Maintainers acknowledge reports within 7 days and coordinate disclosure after triage. ## Scope -This policy covers code in repositories under the `pccxai` organisation. -Hardware test fixtures, draft documentation, and archived directories are out of scope unless the issue affects users running a published artefact. - -## Out of scope - -- Findings that require physical access to a maintainer's machine. -- Issues in third-party dependencies -- report upstream first; tracked here once the upstream advisory is public. -- Theoretical attacks without a working proof of concept. +This placeholder applies to public repositories under the `pccxai` organization unless a repository provides its own security policy. diff --git a/profile/README.md b/profile/README.md index 5ca3047..e7579f6 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,46 +1,3 @@ -# PCCX AI +# pccxai -Open hardware/software research for NPU architecture, FPGA acceleration, and verification tooling. - -## Projects - -### [pccx](https://github.com/pccxai/pccx) - -Specification, documentation, and release coordination across the ecosystem. - -### [pccx-FPGA-NPU-LLM-kv260](https://github.com/pccxai/pccx-FPGA-NPU-LLM-kv260) - -RTL, Sail reference, and KV260 bring-up artifacts. Hardware evidence lives here. - -### [pccx-lab](https://github.com/pccxai/pccx-lab) - -CLI-first verification lab. Provides the shared analyze and status boundary that -editor and launcher integrations consume. Plugin system and external tool interface are planned. -GUI is a secondary surface. - -### [systemverilog-ide](https://github.com/pccxai/systemverilog-ide) - -SystemVerilog IDE spin-out from pccx-lab. Targets diagnostics, xsim log integration, -and reviewed SystemVerilog development workflows. - -### [pccx-llm-launcher](https://github.com/pccxai/pccx-llm-launcher) - -User-facing local LLM launcher, targeting KV260-class edge devices. Currently a -planning scaffold; real launch flow depends on FPGA bring-up evidence from -pccx-FPGA-NPU-LLM-kv260. - -## Roadmap and tracking - -Execution is tracked on the [PCCX Roadmap project](https://github.com/orgs/pccxai/projects/1). -The short release-track summary lives at [pccx/docs/roadmap](https://pccxai.github.io/pccx/en/docs/roadmap.html). - -## Contributing - -Focused issues, documentation improvements, reproducible benchmarks, and small experiments are welcome. -See each repository's `CONTRIBUTING.md` for project-specific guidance. -Open a discussion before starting non-trivial work. - -## Contact - -For security disclosures, see [SECURITY.md](https://github.com/pccxai/.github/blob/main/SECURITY.md). -For other questions, file an issue in the relevant repository. +pccxai is an open hardware and software organization for the pccx architecture, with current public work split across the [v002 KV260 RTL line](https://github.com/pccxai/pccx-FPGA-NPU-LLM-kv260), [pccx-lab verification tooling](https://github.com/pccxai/pccx-lab), the [v003 LLM line](https://github.com/pccxai/pccx-LLM-v003), and the [vision-v001 line](https://github.com/pccxai/pccx-vision-v001); release wording is tied to repository evidence, execution is tracked on the [pccxai project board](https://github.com/orgs/pccxai/projects/1), and the public home page lives in [pccxai/pccxai](https://github.com/pccxai/pccxai).