Neuro_Nomad commited on
Create CONTRIBUTING.md
Browse files- CONTRIBUTING.md +23 -0
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing to Veritas_Core
|
| 2 |
+
|
| 3 |
+
We welcome professional contributions to Veritas_Core. To ensure the integrity of the architecture and the security of the framework, all contributions must adhere to the following guidelines.
|
| 4 |
+
|
| 5 |
+
## Development Standards
|
| 6 |
+
- **Security First**: All changes must undergo a security review. Any commit that introduces a potential vulnerability in the `kernel_interface` or `sovereign_shield` will be rejected.
|
| 7 |
+
- **Minimalism**: Veritas_Core is built on a "low-dependency" philosophy. Do not introduce new external libraries unless absolutely necessary for the core engine.
|
| 8 |
+
- **Code Style**: Code must be clean, modular, and documented. Ensure all new functions have clear docstrings and follow existing naming conventions.
|
| 9 |
+
|
| 10 |
+
## How to Contribute
|
| 11 |
+
1. **Fork the Repository**: Create your own fork of the main branch.
|
| 12 |
+
2. **Feature Branching**: Create a branch for your specific task (e.g., `feature/memory-optimization` or `fix/kernel-bridge`).
|
| 13 |
+
3. **Submit a Pull Request (PR)**: Clearly describe the change, the architectural impact, and the testing performed.
|
| 14 |
+
4. **Review Process**: The lead architect (Neuro_Nomad) will review the PR for security, efficiency, and structural alignment.
|
| 15 |
+
|
| 16 |
+
## Reporting Issues
|
| 17 |
+
If you identify a bug or a security vulnerability, please open an issue with:
|
| 18 |
+
- A clear description of the issue.
|
| 19 |
+
- Steps to reproduce the behavior.
|
| 20 |
+
- Expected vs. actual results.
|
| 21 |
+
- Any relevant logs or kernel telemetry.
|
| 22 |
+
|
| 23 |
+
*Veritas_Core is a sovereign framework. Contributions must uphold the integrity of this mission.*
|