Community

Contributing to XyPriss

Thank you for your interest in contributing to the XyPriss framework. We welcome contributions that align with our mission of providing high-performance, secure, and developer-friendly infrastructure.

License Compliance

XyPriss is licensed under the Nehonix Open Source License (NOSL) v2.0. By contributing to this project, you agree that:

Work for Hire

All contributions, including code, documentation, and assets, are considered "works made for hire" for Nehonix.

IP Protection

Nehonix retains all intellectual property rights. You grant Nehonix a non-exclusive, perpetual, irrevocable, worldwide, royalty-free license to use, modify, and distribute your contributions.

No Unauthorized Distribution

You may not distribute derivative works of XyPriss outside the terms specified in the NOSL without explicit written authorization from Nehonix Legal Department.

For the full legal text, please refer to the LICENSE or visit the Nehonix Legal portal.

Technical Standards

To maintain the integrity and performance of XyPriss, all contributions must adhere to these standards:

Language

Use TypeScript for all application-layer logic and Go for core engine (XHSC) updates.

Modularity

Code must be modular and maintainable. Avoid monolithic functions or classes.

Style & Professionalism

Maintain a professional and serious tone in comments.
No emojis permitted in code or docs.
Use lucide-react for frontend icons if applicable.
Use xfpm for all tasks.

Contribution Workflow

1Environment Setup

To maintain consistency with the XyPriss security and performance model, contributors must adhere to the following setup:

1. Fork the repository and create a feature branch from master.
2. Tooling: Ensure xfpm is installed. npm, yarn, or pnpm are strictly prohibited.
3. Native Engine (XHSC): You must install the XHSC core in a bin/ directory at the project root.

Linux / macOS

curl -sL https://dll.nehonix.com/repo/xypriss/install-xhsc.sh | bash

Windows (PowerShell)

iwr -useb https://dll.nehonix.com/repo/xypriss/install-xhsc.ps1 | iex

Manual download available at dll.nehonix.com.

2Implementation & Validation

Mandatory Simulation

Every contribution must be accompanied by a simulation project located in the simulations/ directory.

tsconfig.json Mapping

"paths": { "xypriss": ["../../src/index.ts"] }

Important: Do not include xypriss in dependencies.

3Submission

Ensure branch is up-to-date with upstream master.
Submit PR with a concise, technical description and simulation link.
Link PR using "Closes #issue-number".

Security Disclosures

Responsible Disclosure Policy

To protect the XyPriss ecosystem, we strictly enforce a responsible disclosure policy. Please do not report security vulnerabilities through public issues. To report a security concern, contact our dedicated security team at:

support@team.nehonix.com

Need clarification?

If you have questions about specific implementation patterns or architectural decisions, please contact our core maintainers.