Skip to content

Commit 44608cf

Browse files
committed
docs(public): publish canonical storefront
1 parent eb0c87a commit 44608cf

76 files changed

Lines changed: 10897 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 436 additions & 0 deletions
Large diffs are not rendered by default.

CHANGELOG.md

Lines changed: 405 additions & 0 deletions
Large diffs are not rendered by default.

CLAUDE.md

Lines changed: 408 additions & 0 deletions
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We want this repository to be a respectful, low-drama place for engineering
6+
discussion, bug reports, documentation fixes, and scoped contributions.
7+
8+
## Expected Behavior
9+
10+
- Be respectful and specific.
11+
- Prefer evidence over heat.
12+
- Assume good intent, but do not hide concrete risks.
13+
- Keep criticism focused on code, behavior, contracts, or documentation.
14+
15+
## Unacceptable Behavior
16+
17+
- Harassment, abuse, or personal attacks
18+
- Discriminatory language
19+
- Publishing private information without permission
20+
- Repeated bad-faith disruption of issue or review threads
21+
22+
## Enforcement
23+
24+
Maintainers may remove comments, close threads, or block participation when
25+
behavior makes the repository unsafe or unproductive.
26+
27+
## Scope
28+
29+
This Code of Conduct applies to repository issues, pull requests, discussions,
30+
and other project communication channels.

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
Thank you for considering a contribution to CortexPilot.
4+
5+
## Good Contributions
6+
7+
- reproducible bug fixes
8+
- documentation improvements
9+
- targeted tests
10+
- narrowly scoped feature work with a clear problem statement
11+
12+
## Please Avoid
13+
14+
- large refactors mixed with behavior changes
15+
- drive-by formatting-only pull requests
16+
- compatibility shims without a removal plan
17+
- policy or license changes without maintainer alignment
18+
19+
## Before You Open A Pull Request
20+
21+
1. Read [README.md](README.md).
22+
2. Read [docs/README.md](docs/README.md).
23+
3. Read the nearest module guide if you touch `apps/orchestrator`, `apps/dashboard`, or `apps/desktop`.
24+
4. Run the relevant verification commands locally.
25+
26+
## Required Standards
27+
28+
- keep changes scoped to one main purpose
29+
- update tests when behavior changes
30+
- update docs when commands, APIs, or public behavior change
31+
- do not commit runtime output, logs, local secrets, or generated noise
32+
- prefer minimal, auditable diffs over broad rewrites
33+
34+
## Pull Request Checklist
35+
36+
- explain what changed and why
37+
- list exact verification commands you ran
38+
- call out unresolved risks
39+
- update documentation when needed
40+
41+
See [`.github/pull_request_template.md`](.github/pull_request_template.md) for the expected format.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Yifeng (Terry) Yu
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

PRIVACY.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Privacy Notes
2+
3+
CortexPilot is source code, not a hosted service.
4+
5+
## Default Local Behavior
6+
7+
Unless you explicitly configure external integrations, expected runtime output
8+
stays local:
9+
10+
- logs under `.runtime-cache/logs/`
11+
- test and governance artifacts under `.runtime-cache/test_output/`
12+
- runtime-generated contracts under `.runtime-cache/cortexpilot/contracts/`
13+
14+
## Sensitive Data Rules
15+
16+
- do not commit real credentials or local `.env` files
17+
- do not commit runtime traces, screenshots, or evidence bundles containing
18+
private data
19+
- redact tokens, cookies, and personal data before sharing logs or screenshots
20+
21+
## Optional Integrations
22+
23+
Some workflows can be connected to external telemetry or tracing providers. If
24+
you enable them in your own environment, you are responsible for reviewing the
25+
provider terms and your own data-handling obligations.

README.md

Lines changed: 785 additions & 0 deletions
Large diffs are not rendered by default.

SECURITY.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Security Policy
2+
3+
## Reporting A Vulnerability
4+
5+
- Do not open a public issue or pull request for a suspected security problem.
6+
- Current live private reporting path: the public repository
7+
`xiaojiou176-open/CortexPilot-public` has GitHub private vulnerability
8+
reporting enabled. Submit reports through the advisory form at
9+
`https://github.com/xiaojiou176-open/CortexPilot-public/security/advisories/new`.
10+
- If that form is unavailable, do not disclose details publicly. This
11+
repository still does not publish a second verified fallback private
12+
reporting channel, so none should be assumed by reporters.
13+
- Maintainer follow-up tail: before calling the security reporting surface
14+
fully closed, publish or verify a non-public fallback path outside public
15+
issues and pull requests.
16+
- Wait for maintainer acknowledgement through the advisory flow before sharing
17+
any details publicly.
18+
19+
## In Scope
20+
21+
Please report issues involving:
22+
23+
- credential handling or secret exposure
24+
- authorization, approval, or replay surfaces
25+
- browser profile, cookie, or automation isolation
26+
- telemetry, evidence, and log redaction
27+
- CI, release, or supply-chain integrity
28+
29+
## What To Include
30+
31+
- affected path or feature
32+
- reproduction steps
33+
- expected and actual behavior
34+
- impact assessment
35+
- any temporary mitigation you tested
36+
37+
## What Not To Include
38+
39+
- real secrets, cookies, tokens, or private data
40+
- exploit details in public channels
41+
- large unrelated refactors mixed with a security report
42+
43+
## Response Expectations
44+
45+
- security reports are triaged on a best-effort basis
46+
- no SLA or bounty program is promised
47+
- coordinated disclosure is preferred
48+
- branch protection and other GitHub security controls should be treated as
49+
separate governance checks; they do not replace the private reporting path
50+
51+
Thank you for helping keep CortexPilot safer for contributors and users.

SUPPORT.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Support
2+
3+
## What To Use GitHub For
4+
5+
- bug reports with clear reproduction steps
6+
- documentation fixes
7+
- narrowly scoped feature proposals
8+
- questions about repository behavior after you have checked the README and docs
9+
10+
## What To Include
11+
12+
- exact command(s) you ran
13+
- exact file path(s) involved
14+
- expected result
15+
- actual result
16+
- relevant logs or screenshots with secrets removed
17+
18+
## What Is Out Of Scope
19+
20+
- private support for custom forks or deployments
21+
- consulting or paid implementation work
22+
- guaranteed response times
23+
- hosted-service style support expectations
24+
- Linux/BSD or Windows desktop runtime support; the current public desktop
25+
support boundary is macOS-only and non-macOS desktop paths are unsupported
26+
27+
## Security Reports
28+
29+
For vulnerabilities, do not open a public issue. Follow
30+
[SECURITY.md](SECURITY.md) and use the documented GitHub advisory form private
31+
path there first on the live public repository. An additional verified fallback
32+
private reporting channel is still not published in the repository docs and
33+
should not be assumed by reporters. If maintainers want a fully closed public
34+
security surface, that fallback must be published or verified separately.
35+
36+
## Before Filing An Issue
37+
38+
1. Read [README.md](README.md).
39+
2. Read [docs/README.md](docs/README.md).
40+
3. Search existing issues and pull requests.

0 commit comments

Comments
 (0)