chore: add all open source structure files

luislucena16 · luislucena16 · commit f6c27b765354 · 2026-01-31T19:18:40.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
+
+## [Unreleased]
+
+### Added
+- Initial changelog.
+
+## [0.0.1] - 2026-01-31
+
+### Added
+- Initial release.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,119 @@
+# Code of Conduct
+
+This project follows the Contributor Covenant Code of Conduct.
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for
+moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at:
+luislucena137@gmail.com.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+Community Impact: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+Consequence: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+Community Impact: A violation through a single incident or series
+of actions.
+
+Consequence: A warning with consequences for continued behavior. No interaction
+with the people involved, including unsolicited interaction with those
+enforcing the Code of Conduct, for a specified period of time. This includes
+avoiding interactions in community spaces as well as external channels like
+social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+Community Impact: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+Consequence: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited
+interaction with those enforcing the Code of Conduct, is allowed during this
+period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+Community Impact: Demonstrating a pattern of violation of community standards,
+including sustained inappropriate behavior, harassment of an individual, or
+aggression toward or disparagement of classes of individuals.
+
+Consequence: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1,
+available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Contributing
+
+Thanks for your interest in contributing to Midnight Escrow System!
+
+## Quick Start
+
+1. Fork the repository and create a feature branch
+2. Install dependencies: `yarn install`
+3. Run a full build: `yarn build:all`
+4. Open a pull request with a clear description
+
+## Development Guidelines
+
+- Keep changes focused and small
+- Add or update documentation when behavior changes
+- Keep security implications in mind for contract/API changes
+
+## Commit and PR Guidelines
+
+- Use clear, descriptive commit messages
+- Reference related issues when applicable
+- Ensure CI passes before requesting review
+
+## Getting Help
+
+If you have questions, open an issue or contact the maintainers listed in `MAINTAINERS.md`.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -0,0 +1,25 @@
+# Governance
+
+## Decision-Making
+
+This project is maintained by the core maintainers listed in `MAINTAINERS.md`. Decisions are made through public discussion in issues and pull requests.
+
+## Proposals and Changes
+
+- Small changes: submit a PR and request review.
+- Significant changes (architecture, breaking changes, roadmap scope): open an issue and include a brief proposal before a PR.
+
+## Maintainer Responsibilities
+
+Maintainers are expected to:
+- Review changes in a timely manner
+- Enforce project standards and security practices
+- Keep documentation and roadmap current
+
+## Conflict Resolution
+
+If maintainers disagree, the default approach is to seek consensus. If consensus cannot be reached, the lead maintainer may make a final decision after a 7-day public discussion period.
+
+## Code of Conduct
+
+This project follows the Contributor Covenant. Reports should be sent to the security contact listed in `SECURITY.md`.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -0,0 +1,14 @@
+# Maintainers
+
+## Core Maintainers
+
+- Luis Lucena (GitHub: luislucena16) – lucenaluis137@gmail.com
+- Hong Jingle (GitHub: jinglescode) – jingles@meshjs.dev
+
+## Responsibilities
+
+Maintainers are responsible for:
+- Reviewing and merging pull requests
+- Managing releases and versioning
+- Maintaining project quality, security, and documentation
+- Triaging issues and engaging with the community
diff --git a/README.md b/README.md
@@ -155,6 +155,10 @@ function App() {
 }
 ```
 
+## Testing
+
+Automated tests are not yet available. CI currently validates builds only.
+Planned test coverage is tracked in `ROADMAP.md`.
 
 ## Try the Project
 
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,16 @@
+# Release Process
+
+## Versioning
+
+We follow Semantic Versioning (SemVer): MAJOR.MINOR.PATCH.
+
+## Release Steps
+
+1. Ensure CI is green on `main`
+2. Update CHANGELOG (if applicable)
+3. Tag the release: `vX.Y.Z`
+4. Create a GitHub Release with notes
+
+## Support Policy
+
+Only the latest release and `main` are supported for security fixes. See `SECURITY.md`.
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -0,0 +1,31 @@
+# Roadmap
+
+Dates below are targets and may shift based on upstream changes and ecosystem priorities.
+
+## Milestone 1 — Dependency & Tooling Refresh (Target: March 31, 2026)
+
+- Upgrade core dependencies across packages (Midnight SDKs, Compact compiler, UI libraries)
+- Resolve deprecations and security advisories
+- Publish an updated SBOM
+- Acceptance criteria:
+  - Builds succeed on CI for all workspaces
+  - Updated lockfile committed
+  - SBOM refreshed and documented
+
+## Milestone 2 — Reliability & Test Coverage (Target: June 30, 2026)
+
+- Add smoke tests for setup workflows (deploy, join, read state)
+- Add basic CLI/API integration tests where feasible
+- Document test coverage and known gaps
+- Acceptance criteria:
+  - Tests run in CI and pass
+  - Test documentation updated in README
+
+## Milestone 3 — UX & Operator Improvements (Target: September 30, 2026)
+
+- Improve onboarding UX for dApp setup and contract workflows
+- Add clearer network configuration messaging in UI/CLI
+- Update documentation with common troubleshooting steps
+- Acceptance criteria:
+  - Updated UI/CLI documentation
+  - Demo flow completed without manual patching
diff --git a/SBOM.md b/SBOM.md
@@ -0,0 +1,26 @@
+# SBOM
+
+This project publishes a CycloneDX Software Bill of Materials (SBOM).
+
+## Generate
+
+From the repo root:
+
+```sh
+corepack enable
+npm_config_yes=true npx @cyclonedx/cyclonedx-npm --output-file sbom.cdx.json --output-format json
+```
+
+Commit the updated `sbom.cdx.json` to the repository.
+
+## Validate (basic)
+
+Parse the file and print key fields:
+
+```sh
+node -e "const fs=require('fs');const d=JSON.parse(fs.readFileSync('sbom.cdx.json','utf8'));console.log('bomFormat:',d.bomFormat);console.log('specVersion:',d.specVersion);console.log('version:',d.version);console.log('components:',(d.components||[]).length);"
+```
+
+## Current File
+
+- `sbom.cdx.json` (CycloneDX JSON format)
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,23 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security issue, please report it privately by email:
+
+- Email: luislucena137@gmail.com
+
+Please include:
+- A clear description of the issue
+- Steps to reproduce
+- Affected components/versions
+- Any proof of concept or logs (if available)
+
+We aim to acknowledge reports within 72 hours and provide a remediation plan or fix timeline within 10 business days.
+
+## Supported Versions
+
+Security fixes are provided for:
+- `main` branch
+- Latest tagged release
+
+Older versions are not actively supported.
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,8 @@
+# Support
+
+If you need help using this project or have questions, please use one of the following:
+
+- Open an issue in the GitHub repository for general questions and requests.
+- For security concerns, follow the process in `SECURITY.md`.
+
+For community help, see the contacts in `MAINTAINERS.md`.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "midnight-quick-starter",
   "version": "1.0.0",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "scripts": {
     "build": "turbo run build",
     "build:all": "cd packages/contract && npx turbo run build && cd ../api && yarn build && cd ../cli && npx turbo run build && cd ../ui && npx turbo run build",
diff --git a/sbom.cdx.json b/sbom.cdx.json

Original file line number	Diff line number	Diff line change
`@@ -155,6 +155,10 @@ function App() {`
`155`	`155`	`}`
`156`	`156`	```
`157`	`157`
	`158`	`+## Testing`
	`159`	`+`
	`160`	`+Automated tests are not yet available. CI currently validates builds only.`
	`161`	+Planned test coverage is tracked in `ROADMAP.md`.
`158`	`162`
`159`	`163`	`## Try the Project`
`160`	`164`