Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ OPENBUSINESS_PROVIDER=openai
# Report language (zh / en)
OPENBUSINESS_OUTPUT_LANGUAGE=zh

# Terminal interface language (zh / en)
OPENBUSINESS_UI_LANGUAGE=zh

OPENAI_API_KEY=sk-xxx
ANTHROPIC_API_KEY=sk-ant-xxx
DEEPSEEK_API_KEY=sk-xxx
Expand Down
50 changes: 50 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: CI

on:
pull_request:
push:
branches:
- main
- "codex/**"

permissions:
contents: read

jobs:
checks:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12"]

steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: pip

- name: Install package
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install -e ".[dev]"

- name: Lint
run: python -m ruff check openbusiness

- name: Compile
run: python -m compileall openbusiness

- name: Validate installer shell syntax
run: bash -n install.sh

- name: Smoke-test packaged resources
run: |
python -m openbusiness.cli packs
python -m openbusiness.cli templates

- name: Keep README English-only
run: "! grep -P '[\\x{3400}-\\x{9fff}]' README.md"
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ build/
.venv/
output/
.ruff_cache/
.DS_Store
87 changes: 87 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Contributing to OpenBusiness

Thanks for helping improve OpenBusiness. This is a co-building project for
people who want better evidence-first company analysis. Contributions should
make reports more accurate, more useful, easier to verify, easier to extend, or
easier to run.

## Co-Building Principles

- Evidence beats confident prose.
- Clear missing data is better than fake certainty.
- Preserve the evidence labels. Knowing, inferring, and admitting missing data
are separate states.
- Practical workflows matter as much as model output quality.
- Bilingual support should be treated as a first-class feature.
- Good examples are valuable contributions, even when they reveal weaknesses.

## Good First Contributions

- Improve analyst prompts with clearer reasoning standards.
- Add evidence sources or make existing tools more reliable.
- Add an analysis pack for a specific domain.
- Add a report template for a specific reader workflow.
- Add provider support for more LLM APIs.
- Improve bilingual output quality.
- Add report examples that expose weak reasoning or missing data.
- Improve installation, documentation, or troubleshooting.
- Share benchmark companies where the current pipeline produces shallow,
generic, or wrong conclusions.

## Local Setup

```bash
git clone https://github.com/wanikua/OpenBusiness.git
cd OpenBusiness
./install.sh
source .venv/bin/activate
python -m pip install -e ".[dev]"
```

## Checks

Run these before opening a pull request:

```bash
python -m ruff check openbusiness
python -m compileall openbusiness
python -m openbusiness.cli packs
python -m openbusiness.cli templates
```

If your change affects installation, also run:

```bash
bash -n install.sh
```

## Pull Request Guidelines

- Keep changes focused. Avoid mixing unrelated refactors with feature work.
- Preserve evidence labels: `[VERIFIED:url]`, `[INFERRED]`, and `[MISSING]`.
- Analysis packs and report templates may change the lens, but must not weaken
the evidence-label contract.
- Do not commit API keys, generated reports, local config, or virtual
environments.
- Keep README and top-level project metadata in English.
- When changing prompts, explain how the change improves report depth, evidence
quality, language purity, or runtime.
- When changing tools, make failure modes explicit and graceful.

## Issue Guidelines

Useful issues include:

- A company analysis that produced shallow or wrong reasoning.
- A missing data source that would materially improve evidence quality.
- A proposed analysis pack or report template with a concrete company example.
- A provider or model that fails to follow tool calls or language constraints.
- Installation friction on a specific OS, shell, or Python version.

Please include the command you ran, expected behavior, actual behavior, and any
safe-to-share logs. Do not paste private API keys.

## Community Standards

Keep discussions technical and evidence-oriented. Strong disagreement is fine;
unsupported claims, personal attacks, and promotional spam are not.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 OpenBusiness contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading
Loading