Skip to content

Commit 3ef55e6

Browse files
committed
feat: prepare IC Copilot public launch
1 parent ad9e91c commit 3ef55e6

41 files changed

Lines changed: 2626 additions & 320 deletions

Some content is hidden

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

.devcontainer/devcontainer.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "IC Copilot",
3+
"build": {
4+
"dockerfile": "../Dockerfile",
5+
"context": ".."
6+
},
7+
"overrideCommand": true,
8+
"remoteUser": "appuser",
9+
"forwardPorts": [8501],
10+
"postCreateCommand": "python -m pip install -e '.[dev]'",
11+
"customizations": {
12+
"vscode": {
13+
"extensions": [
14+
"ms-python.python",
15+
"charliermarsh.ruff"
16+
]
17+
}
18+
}
19+
}

.dockerignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.git
2+
.github
3+
.idea
4+
.pytest_cache
5+
__pycache__
6+
*.pyc
7+
*.log
8+
.env
9+
.env.local
10+
data/*.db
11+
data/*.sqlite*
12+
venv
13+
docs/launch
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Add or improve an ADR/FPI profile
2+
description: Propose a cross-listed security identity and reporting profile.
3+
title: "[ADR/FPI] "
4+
labels: ["data coverage", "good first issue"]
5+
body:
6+
- type: input
7+
id: security
8+
attributes:
9+
label: Security and issuer
10+
placeholder: BABA / 9988.HK - Alibaba Group Holding Limited
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: identity
15+
attributes:
16+
label: Identity details
17+
description: Include ADR ratio, ordinary listing, reporting currency, home exchange, fiscal year-end, and primary forms.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: sources
22+
attributes:
23+
label: Official sources
24+
description: List issuer IR and exchange/regulator URLs. Do not paste credentials or licensed full text.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: tests
29+
attributes:
30+
label: Proposed fixtures
31+
description: Explain identity, ratio, currency, and filing-form tests.
32+
validations:
33+
required: true

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Bug report
2+
description: Report a reproducible app, provider, parser, or research-workflow defect.
3+
title: "[Bug]: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Never include API keys, proxy credentials, licensed reports, or local databases.
9+
- type: input
10+
id: ticker
11+
attributes:
12+
label: Ticker or demo
13+
placeholder: AAPL, BABA, or frozen demo
14+
- type: dropdown
15+
id: profile
16+
attributes:
17+
label: Research profile
18+
options: [Fast Screening, Adaptive IC Research, Deep Initiation, Investigate This Event, Frozen demo]
19+
- type: textarea
20+
id: behavior
21+
attributes:
22+
label: What happened?
23+
description: Include the visible error and the workflow stage.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: expected
28+
attributes:
29+
label: Expected behavior
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: reproduce
34+
attributes:
35+
label: Reproduction steps
36+
validations:
37+
required: true
38+
- type: input
39+
id: environment
40+
attributes:
41+
label: Environment
42+
placeholder: Windows 11, Python 3.11, Streamlit 1.x
43+
- type: checkboxes
44+
id: safety
45+
attributes:
46+
label: Safety check
47+
options:
48+
- label: I removed credentials, private research, and licensed full text.
49+
required: true
50+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Research methodology discussion
4+
url: https://github.com/mwsp-code/IC-Copilot/discussions
5+
about: Discuss research design, playbooks, evidence gates, and roadmap ideas.
6+
- name: Security report
7+
url: https://github.com/mwsp-code/IC-Copilot/security/policy
8+
about: Report credential, source-integrity, or local API vulnerabilities privately.
9+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Feature request
2+
description: Propose an analyst workflow or contributor improvement.
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Analyst or contributor problem
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: workflow
14+
attributes:
15+
label: Proposed workflow
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: integrity
20+
attributes:
21+
label: Evidence, licensing, and failure-state considerations
22+
- type: textarea
23+
id: acceptance
24+
attributes:
25+
label: Acceptance criteria
26+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Sector or industry playbook
2+
description: Add material drivers, KPIs, peers, valuation methods, and falsification tests.
3+
title: "[Playbook]: "
4+
labels: [sector-playbook, good-first-issue]
5+
body:
6+
- type: input
7+
id: sector
8+
attributes:
9+
label: Sector or industry
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: economics
14+
attributes:
15+
label: Business economics and material KPIs
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: peers
20+
attributes:
21+
label: Curated peers and selection rationale
22+
- type: textarea
23+
id: valuation
24+
attributes:
25+
label: Valuation and credit methods
26+
- type: textarea
27+
id: tests
28+
attributes:
29+
label: Confirmation, contradiction, and fixture cases
30+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Source adapter proposal
2+
description: Propose or implement a registered official, market, macro, or research provider.
3+
title: "[Source]: "
4+
labels: [source-adapter]
5+
body:
6+
- type: input
7+
id: provider
8+
attributes:
9+
label: Provider and endpoint family
10+
validations:
11+
required: true
12+
- type: dropdown
13+
id: tier
14+
attributes:
15+
label: Proposed source tier
16+
options: [Tier 1 primary, Tier 2 official/context, Tier 3 licensed/reporting, Tier 4 unofficial/narrative]
17+
- type: textarea
18+
id: fields
19+
attributes:
20+
label: Research fields and causal-bridge use
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: licensing
25+
attributes:
26+
label: Authentication, entitlement, licensing, and retention policy
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: fallback
31+
attributes:
32+
label: Failure classification and fallback
33+
- type: checkboxes
34+
id: contract
35+
attributes:
36+
label: Adapter contract
37+
options:
38+
- label: I will preserve timestamps, citations, units, currencies, provider health, and no-lookahead eligibility.
39+
required: true
40+
- label: Normal tests will use fixtures and require no live credentials.
41+
required: true
42+

.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: pip
4+
directory: "/"
5+
schedule:
6+
interval: weekly
7+
open-pull-requests-limit: 5
8+
- package-ecosystem: github-actions
9+
directory: "/"
10+
schedule:
11+
interval: monthly
12+

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## What changed
2+
3+
Describe the user or research problem and the smallest useful change.
4+
5+
## Evidence integrity
6+
7+
- [ ] Source URL, publication/filing time, period, unit, and currency are preserved.
8+
- [ ] Missing values remain `Unknown` rather than zero.
9+
- [ ] No-lookahead behavior is preserved.
10+
- [ ] LLM output cannot introduce unsupported facts, citations, targets, or promotion.
11+
- [ ] No credentials, licensed full text, databases, logs, or vendor payloads are included.
12+
13+
## Verification
14+
15+
- [ ] Targeted tests added or updated.
16+
- [ ] Full test suite passes.
17+
- [ ] Streamlit startup smoke check passes when UI behavior changed.
18+
- [ ] Screenshots included for visible UI changes.
19+
20+
## Data and licensing
21+
22+
List new providers, endpoints, licensing constraints, retention rules, and fallbacks.
23+

0 commit comments

Comments
 (0)