Italianhype commited on
Commit
cde2789
·
1 Parent(s): 7aff92e

docs: establish BLUM open-source governance

Browse files
.github/ISSUE_TEMPLATE/bug_report.yml ADDED
@@ -0,0 +1,33 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Bug report
2
+ description: Report a reproducible defect in BLUM.
3
+ title: "[Bug]: "
4
+ labels: [bug]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: Do not include credentials, personal data or proprietary datasets.
9
+ - type: textarea
10
+ id: observed
11
+ attributes:
12
+ label: Observed behavior
13
+ description: What happened, including the affected route, worker or engine.
14
+ validations:
15
+ required: true
16
+ - type: textarea
17
+ id: expected
18
+ attributes:
19
+ label: Expected behavior
20
+ validations:
21
+ required: true
22
+ - type: textarea
23
+ id: reproduce
24
+ attributes:
25
+ label: Reproduction
26
+ description: Minimal steps, revision and relevant non-sensitive logs.
27
+ validations:
28
+ required: true
29
+ - type: textarea
30
+ id: evidence
31
+ attributes:
32
+ label: Evidence and impact
33
+ description: Explain data integrity, financial logic or runtime impact.
.github/ISSUE_TEMPLATE/feature_request.yml ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Evidence-driven proposal
2
+ description: Propose a change that improves BLUM's decision intelligence.
3
+ title: "[Proposal]: "
4
+ labels: [enhancement]
5
+ body:
6
+ - type: textarea
7
+ id: problem
8
+ attributes:
9
+ label: Measured problem
10
+ description: What limitation is observable today?
11
+ validations:
12
+ required: true
13
+ - type: textarea
14
+ id: decision_quality
15
+ attributes:
16
+ label: Decision-quality impact
17
+ description: How should this improve selection, risk, learning or validation?
18
+ validations:
19
+ required: true
20
+ - type: textarea
21
+ id: validation
22
+ attributes:
23
+ label: Validation plan
24
+ description: Define tests, benchmarks, sample thresholds and rollback.
25
+ validations:
26
+ required: true
.github/pull_request_template.md ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## Problem and evidence
2
+
3
+ <!-- Describe the measured problem. -->
4
+
5
+ ## Change
6
+
7
+ <!-- Keep financial logic, runtime and UI responsibilities explicit. -->
8
+
9
+ ## Verification
10
+
11
+ <!-- Include commands, results, sample sizes and benchmark methodology. -->
12
+
13
+ ## Risk and rollback
14
+
15
+ <!-- State data, look-ahead, compatibility and operational risks. -->
16
+
17
+ - [ ] No credentials or restricted data are included.
18
+ - [ ] GET endpoints remain read-only.
19
+ - [ ] No frontend render triggers heavy computation.
20
+ - [ ] Financial claims are evidence-bound.
21
+ - [ ] Tests cover the changed behavior.
CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Code of Conduct
2
+
3
+ ## Our commitment
4
+
5
+ We commit to a professional, inclusive and evidence-focused community. Debate
6
+ technical and financial claims rigorously while treating contributors with
7
+ respect.
8
+
9
+ ## Expected behavior
10
+
11
+ - Be precise, constructive and transparent about uncertainty.
12
+ - Critique ideas and evidence, not people.
13
+ - Disclose conflicts of interest and data limitations.
14
+ - Respect privacy, licensing and responsible disclosure.
15
+ - Do not promote harassment, discrimination, market manipulation or deceptive
16
+ performance claims.
17
+
18
+ ## Enforcement
19
+
20
+ Maintainers may edit, reject or remove contributions and participation that
21
+ violate these standards. Serious security or safety concerns should be reported
22
+ privately as described in `SECURITY.md`.
CONTRIBUTING.md ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributing to BLUM
2
+
3
+ BLUM welcomes reproducible contributions that improve evidence quality,
4
+ decision quality, risk control, learning reliability or runtime performance.
5
+
6
+ ## Before opening a change
7
+
8
+ 1. Search existing issues and discussions.
9
+ 2. Describe the observed problem and the evidence that it exists.
10
+ 3. Keep financial logic separate from runtime and presentation concerns.
11
+ 4. Never add fabricated market data, guaranteed-return claims or hidden
12
+ self-modification.
13
+ 5. Keep GET endpoints read-only and page rendering snapshot-first.
14
+
15
+ ## Development workflow
16
+
17
+ 1. Fork `BlumFinancialLab/Blum` and create a focused branch.
18
+ 2. Add or update tests before changing behavior.
19
+ 3. Run the smallest relevant test set, then the full affected suite.
20
+ 4. Document data lineage, point-in-time constraints and benchmark methodology.
21
+ 5. Open a pull request with before/after evidence and known limitations.
22
+
23
+ Useful commands:
24
+
25
+ ```bash
26
+ python3 -m pytest -q
27
+ pnpm --dir frontend test
28
+ pnpm --dir frontend build
29
+ ```
30
+
31
+ ## Data and model contributions
32
+
33
+ Do not commit credentials, personal information, proprietary datasets or data
34
+ whose redistribution terms are unclear. Training examples must preserve
35
+ point-in-time evidence, source provenance and licensing metadata. Community
36
+ memory is quarantined and reviewed; it never changes production weights merely
37
+ because it was uploaded.
38
+
39
+ ## Financial safety
40
+
41
+ BLUM is research and paper-trading software. Contributions must not introduce
42
+ real-money execution, guaranteed-profit language or benchmark claims without
43
+ stored evidence and sufficient samples.
44
+
45
+ By submitting a contribution, you agree that it is licensed under Apache-2.0.
GOVERNANCE.md ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # BLUM Governance
2
+
3
+ BLUM is developed in public under the Apache-2.0 license. The canonical source
4
+ repository is `BlumFinancialLab/Blum`; Hugging Face hosts the public deployment,
5
+ model artifacts and governed datasets.
6
+
7
+ ## Decision principles
8
+
9
+ - Evidence outranks confidence.
10
+ - Point-in-time correctness outranks backtest appearance.
11
+ - Capital preservation outranks forced activity.
12
+ - Stored, reproducible outcomes outrank marketing metrics.
13
+ - Financial intelligence belongs in the Engine; presentation belongs in the
14
+ Runtime; model artifacts assist reasoning but are not market truth.
15
+
16
+ ## Change control
17
+
18
+ Maintainers review changes for correctness, licensing, data provenance,
19
+ look-ahead bias, reproducibility, security and backward compatibility. Risky
20
+ weight or rule changes require explicit evidence and reversible activation.
21
+ Source code is never modified autonomously by BLUM.
22
+
23
+ ## Community evidence
24
+
25
+ External usage does not silently transmit data. Contributions are opt-in,
26
+ redacted, versioned and quarantined before they can enter a future training
27
+ snapshot. A submitted example never changes the active model directly.
LICENSE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 BLUM Financial Lab contributors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
README.md CHANGED
@@ -12,6 +12,29 @@ pinned: false
12
 
13
  # BLUM v2.0 Project Split
14
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
  ## BLUM v2.1 Clean Core Release
16
 
17
  BLUM v2.1 tightens the v2.0 split around the four product surfaces that matter to the trader brain:
@@ -1977,7 +2000,11 @@ Development standards are tracked in [`ENGINEERING_STANDARDS.md`](ENGINEERING_ST
1977
 
1978
  ## Contributing
1979
 
1980
- Contributions should preserve the project philosophy: transparent evidence, modular models, explainable scoring, no fabricated data and no investment recommendations.
 
 
 
 
1981
  ## Autonomous Forex Alpha Trader
1982
 
1983
  BLUM includes a paper-only Forex decision core for selective scalping and short
 
12
 
13
  # BLUM v2.0 Project Split
14
 
15
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
16
+ [![Hugging Face Space](https://img.shields.io/badge/Hugging%20Face-Space-yellow)](https://huggingface.co/spaces/Italianhype/Blum)
17
+ [![BLUM Finance Model](https://img.shields.io/badge/Model-BLUM%20Finance-orange)](https://huggingface.co/Italianhype/Blum)
18
+
19
+ ## Open-Source Project
20
+
21
+ [`BlumFinancialLab/Blum`](https://github.com/BlumFinancialLab/Blum) is the
22
+ canonical public source repository. The application code is licensed under
23
+ [Apache-2.0](LICENSE); contributions follow [CONTRIBUTING.md](CONTRIBUTING.md),
24
+ [GOVERNANCE.md](GOVERNANCE.md) and [SECURITY.md](SECURITY.md).
25
+
26
+ The public surfaces have distinct responsibilities:
27
+
28
+ - **GitHub**: source code, issues, pull requests and engineering history.
29
+ - **Hugging Face Space**: public, paper-only deployment of the Runtime.
30
+ - **Hugging Face Models**: downloadable BLUM Finance model artifacts.
31
+ - **Hugging Face Datasets**: versioned reasoning and opt-in community-memory
32
+ datasets with their own dataset cards and provenance constraints.
33
+
34
+ BLUM sends no usage telemetry by default. Community evidence is contributed
35
+ only through an explicit, redacted workflow and is quarantined before review;
36
+ downloads never modify active model weights automatically.
37
+
38
  ## BLUM v2.1 Clean Core Release
39
 
40
  BLUM v2.1 tightens the v2.0 split around the four product surfaces that matter to the trader brain:
 
2000
 
2001
  ## Contributing
2002
 
2003
+ Contributions should preserve the project philosophy: transparent evidence,
2004
+ modular models, explainable scoring, no fabricated data and no investment
2005
+ recommendations. See [CONTRIBUTING.md](CONTRIBUTING.md) for the development and
2006
+ data-contribution workflow, [GOVERNANCE.md](GOVERNANCE.md) for change control and
2007
+ [SECURITY.md](SECURITY.md) for private vulnerability reporting.
2008
  ## Autonomous Forex Alpha Trader
2009
 
2010
  BLUM includes a paper-only Forex decision core for selective scalping and short
SECURITY.md ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Security Policy
2
+
3
+ ## Supported version
4
+
5
+ Security fixes target the current `main` branch. Historical revisions may not
6
+ receive backports.
7
+
8
+ ## Reporting a vulnerability
9
+
10
+ Do not disclose exploitable vulnerabilities in a public issue. Use GitHub's
11
+ private vulnerability reporting for `BlumFinancialLab/Blum` when available.
12
+ Include affected revisions, reproduction steps, impact and a proposed remedy if
13
+ known. Never include live credentials, broker secrets or personal financial
14
+ data in a report.
15
+
16
+ ## Scope
17
+
18
+ High-priority reports include credential exposure, unauthorized database
19
+ access, unsafe model or dataset ingestion, server-side request forgery,
20
+ dependency compromise and any path that could turn paper-only behavior into
21
+ real execution.
22
+
23
+ BLUM does not request brokerage credentials and does not execute real-money
24
+ orders. A deployment that adds those capabilities is outside the supported
25
+ security boundary.