Skip to content
This repository was archived by the owner on Apr 3, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ We believe in:
- Push to your branch: `git push origin feature/amazing-feature`
- Open a Pull Request.

## 🧭 High-Impact Contribution Areas

If you want to jump in quickly, review our [Developer Call to Action](../docs/DEVELOPER_CALL_TO_ACTION.md) for architecture, AI integration, accessibility, language design, and DevOps priorities.

## 🛠️ Development Setup

1. **Fork & Clone**
Expand Down
109 changes: 3 additions & 106 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -630,113 +630,10 @@ Check the latest system health report: [docs/notes/HyperCode_Health_Check_Report

## 🤝 Contributing

We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
We welcome contributions from everyone, especially neurodivergent developers!

**Neurodivergent contributors especially welcome.** See [Contributor Guidelines](#-contributor-guidelines-maintaining-neuro-inclusive-design) above for how we maintain accessibility standards.

---

## 🤖 AI Disclosure Policy

This policy describes how Generative AI (GenAI) tools (e.g. large language models, code assistants, chat-based coding copilots) may be used within the HyperCode project and how such use must be disclosed.

### 1. Scope

- **Project scope**: This policy applies to all HyperCode repositories, submodules, agents, and related tooling maintained under the HyperCode V2.0 ecosystem.
- **Contributor scope**: It applies to all contributors, whether core maintainers, occasional contributors, or automated agents acting on behalf of maintainers.
- **Content scope**: It covers all project artefacts, including source code, configuration, tests, documentation, examples, and generated assets where GenAI influenced the result.
- **Tool scope**: It specifically regulates the use of **Generative AI** (LLMs, code assistants, chatbots, etc.) and does *not* restrict deterministic code generation, formal methods, or non-GenAI automation.

### 2. Core Principles

This policy is grounded in the principles used by NLnet for GenAI in funded projects.

- **Free/Libre/Open Source (FLOS)**: All outputs must remain compatible with recognised free and open-source licences; GenAI-assisted outputs must not introduce incompatible or copyrighted material.
- **No misrepresentation**: Contributors must not present AI-generated content as if it were fully human-authored work; human authorship and AI assistance must be clearly distinguishable.
- **Human responsibility**: Human contributors remain fully responsible for correctness, clarity, and reproducibility of all project outputs, including those assisted by GenAI.
- **Transparency**: Substantive use of GenAI that materially affects project outputs must be clearly disclosed and traceable for users, auditors, and other contributors.

### 3. AI Tool Usage Guidelines

#### 3.1 Allowed Uses (with disclosure)

The following uses of GenAI are allowed, provided they are disclosed according to this policy:

- **Code assistance**: Generating boilerplate, scaffolding, tests, or refactoring suggestions for project code.
- **Documentation support**: Drafting or restructuring documentation, comments, tutorials, or examples.
- **Testing and analysis**: Generating test cases, fuzz ideas, or static analysis suggestions using GenAI.
- **Design exploration**: Producing alternative designs, pseudo-code, or API sketches that are later refined by humans.

#### 3.2 Disallowed or Restricted Uses

- **Pure AI deliverables**: Outcomes that are purely generated by AI, without substantial human intellectual contribution, must **not** be submitted as work products treated as human-authored deliverables (e.g. milestones for payment in NLnet-funded work).
- **Hidden AI authorship**: It is not permitted to use GenAI to produce project artefacts and then present them as purely human work.
- **Unvetted code**: AI-generated code must not be merged or released without human review and understanding of the changes.
- **Terms of use conflicts**: GenAI tools must not be used if their terms of service risk introducing copyrighted or licence-incompatible content into the project.

### 4. Contributor Responsibilities

All contributors using GenAI for HyperCode have the following responsibilities:

- **Attribution and disclosure**: Clearly indicate where GenAI was used, including the model name, version (where known), and the nature of the assistance.
- **Provenance tracking**: Maintain a record (commit message, issue, or log file) that links AI-generated segments to the prompts and outputs used, or a concise summary thereof.
- **Human validation**: Review and, where necessary, edit AI outputs so that you can explain and justify the design and code decisions.
- **Licensing checks**: Verify that AI outputs do not reproduce incompatible or copyrighted material and remain suitable for FLOS licensing.

### 5. Disclosure Formatting Requirements

#### 5.1 Repository-Level Disclosure

At repository level, HyperCode maintains this **AI Disclosure Policy** section in the README to document:

- Whether and how GenAI is used in the project (e.g. for logic, boilerplate, tests, documentation, etc.).
- Expectations and rules for contributors when using GenAI.

If a particular sub-project or component follows stricter rules, that should be documented in its local README, referencing this policy.

#### 5.2 Commit-Level Disclosure

For any **substantive** use of GenAI that materially affects project outputs (code, tests, or documentation), the responsible contributor must:

- Use the project's `.gitmessage` template (see below) when committing.
- Include, in the commit message:
- A short human-readable description of the change.
- An **AI Disclosure** block specifying:
- Model name and provider (e.g. `gpt-5.1 (Perplexity)`),
- Estimated percentage of the diff generated or heavily influenced by GenAI,
- A brief description of how GenAI was used (e.g. "generated initial test file", "suggested refactor"),
- Confirmation that a human reviewed and validated the changes.

Generated content should be clearly marked as such in the commit message, and where practical, in code comments near large AI-generated blocks.

#### 5.3 Non-Substantive / Low-Risk Uses

If GenAI is used only for:

- Brainstorming,
- High-level design discussions, or
- Minor edits to wording in documentation,

then a high-level statement in the commit message (e.g. "Doc phrasing adjusted with GenAI assistance") is sufficient, as long as the overall stance is clear in the README.

### 6. Compliance Checklist

Before merging or submitting work that involved GenAI, verify the following:

1. **FLOS compatibility**
- I have checked that no AI output introduces non-free or incompatible licensing issues.
2. **Attribution \& transparency**
- I have clearly marked AI-assisted content and included an AI Disclosure block in my commit message where applicable.
3. **Human responsibility**
- I understand the code/content produced and can explain any design or implementation decisions.
4. **Provenance**
- I have recorded the GenAI model and its usage (and prompts, where relevant) in a durable place (commit message, issue, or internal log).
5. **Quality**
- Use of GenAI has not reduced the clarity, reliability, or reproducibility of the work.
6. **Policy alignment**
- My use of GenAI is consistent with NLnet's Generative AI policy and this project's AI Disclosure Policy.

Failure to follow this policy may lead to rejection of contributions in this project and, where NLnet funding is involved, may contribute to non-compliance with NLnet's GenAI policy.
- Start here: [Contributing Guide](.github/CONTRIBUTING.md)
- Looking for high-impact areas: [Developer Call to Action](docs/DEVELOPER_CALL_TO_ACTION.md)

---

Expand Down
74 changes: 74 additions & 0 deletions docs/DEVELOPER_CALL_TO_ACTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 💻 Calling All Developers: Build HyperCode With Us

HyperCode is a **neurodivergent-first programming language and AI-native development ecosystem**. We are actively inviting contributors to challenge our assumptions, improve our architecture, and help shape the roadmap.

## 🛠️ Where Your Expertise Helps Most

### Architecture & Language Design
- Identify weaknesses in language structure and runtime design.
- Suggest safer, cleaner patterns for syntax and semantics.
- Propose performance improvements (memory, speed, scalability).
- Highlight security concerns we should address early.

### Tooling & DevOps
- CI/CD hardening and release pipeline improvements.
- Better testing strategy (unit, integration, property/edge tests).
- Build and automation improvements.
- Better developer experience (debugging, error clarity, IDE support).

### AI Integration
- Multi-model compatibility patterns.
- Flexible API design for model/provider switching.
- Prompt engineering workflows for code generation reliability.
- Context management strategies to reduce hallucinations and drift.

### Accessibility & UX
- Dyslexia-friendly syntax and formatting ideas.
- Visual/spatial coding interface concepts.
- Error messaging designed for neurodivergent cognition.
- Documentation structures that reduce cognitive overhead.

### Language Features
- Syntax that lowers cognitive load.
- Novel operators/constructs worth exploring.
- Better ways to express state, flow, and data transformations.
- Inspiration from underused or research languages.

### Forward-Looking Compute (Quantum / Molecular)
- Early abstraction patterns for future hardware.
- Design layers that could age well over 5–10 years.
- Papers and projects we should track or evaluate.

## 🎯 Contribution Paths

### Quick hits (10–15 minutes)
- Leave suggestions on specific files/folders.
- Open issues tagged to your specialty.
- Share concise “Please consider…” recommendations.

### Deep collaboration
- Propose architectural changes through PRs.
- Build proof-of-concept implementations.
- Contribute to compiler/interpreter design.
- Build tooling, integrations, or IDE plugins.

### Knowledge transfer
- Share patterns from other languages/systems.
- Call out common pitfalls early.
- Link papers, projects, or references with practical relevance.

## 📍 Where to Join In
- **Repository:** https://github.com/welshDog/HyperCode-V2.0
- **Issues:** report bugs, request features, suggest improvements
- **Pull Requests:** ship concrete changes
- **Discussions/Wiki/Docs:** share ideas and improve clarity

## 🔥 Collaboration Principle

HyperCode is intentionally iterative and transparent. Strong critique, concrete suggestions, and experimental ideas are all welcome.

If your work improves clarity, accessibility, reliability, or developer flow, it belongs here.

---

Programming languages should fit **all minds**, not just some. Help us build that future.