Skip to content

Commit 960a4b1

Browse files
committed
Update Korean README intro
1 parent 2de35ce commit 960a4b1

8 files changed

Lines changed: 560 additions & 32 deletions

File tree

.github/workflows/ci.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: ci
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Node
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: "22"
21+
cache: "npm"
22+
23+
- name: Install root dependencies
24+
run: npm ci
25+
26+
- name: Build
27+
run: npm run build
28+
29+
- name: Test
30+
run: npm test

CODE_OF_CONDUCT.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Taking responsibility and apologizing to those affected by our mistakes
24+
- Focusing on what is best not just for us as individuals, but for the overall
25+
community
26+
27+
Examples of unacceptable behavior include:
28+
29+
- The use of sexualized language or imagery, and sexual attention or advances
30+
of any kind
31+
- Trolling, insulting or derogatory comments, and personal or political attacks
32+
- Public or private harassment
33+
- Publishing others' private information, such as a physical or email address,
34+
without their explicit permission
35+
- Other conduct which could reasonably be considered inappropriate in a
36+
professional setting
37+
38+
## Enforcement Responsibilities
39+
40+
Community leaders are responsible for clarifying and enforcing our standards of
41+
acceptable behavior and will take appropriate and fair corrective action in
42+
response to any behavior that they deem inappropriate, threatening, offensive,
43+
or harmful.
44+
45+
Community leaders have the right and responsibility to remove, edit, or reject
46+
comments, commits, code, wiki edits, issues, and other contributions that are
47+
not aligned to this Code of Conduct, and will communicate reasons for
48+
moderation decisions when appropriate.
49+
50+
## Scope
51+
52+
This Code of Conduct applies within all community spaces, and also applies when
53+
an individual is officially representing the community in public spaces.
54+
Examples of representing our community include using an official email address,
55+
posting via an official social media account, or acting as an appointed
56+
representative at an online or offline event.
57+
58+
## Enforcement
59+
60+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
61+
reported to the project maintainers through GitHub's private contact channels
62+
or any private security reporting path documented in `SECURITY.md`.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by
121+
https://github.com/mozilla/diversity.
122+
123+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Contributing to AutoResearch
2+
3+
Thanks for taking the time to contribute.
4+
5+
## Before you start
6+
7+
- Check existing issues and pull requests before starting large changes.
8+
- Open an issue for feature work that changes workflow behavior, CLI surface, or repository structure.
9+
- Keep pull requests focused. Small, reviewable changes move faster than broad rewrites.
10+
11+
## Local setup
12+
13+
Requirements:
14+
15+
- Node.js 18 or newer
16+
- npm
17+
- Optional for `/doctor` and PDF generation: `pdflatex`
18+
- Runtime keys for end-to-end flows: `SEMANTIC_SCHOLAR_API_KEY`
19+
- Optional runtime key for API-backed modes: `OPENAI_API_KEY`
20+
21+
Install dependencies:
22+
23+
```bash
24+
npm install
25+
```
26+
27+
Build the CLI and bundled web UI:
28+
29+
```bash
30+
npm run build
31+
```
32+
33+
Run tests:
34+
35+
```bash
36+
npm test
37+
```
38+
39+
Start the TUI:
40+
41+
```bash
42+
npm run dev
43+
```
44+
45+
Start the local web UI:
46+
47+
```bash
48+
npm run dev:web
49+
```
50+
51+
## Development notes
52+
53+
- Main CLI entrypoint: `src/cli/main.ts`
54+
- TUI app flow: `src/tui/TerminalApp.ts`
55+
- Interaction/session layer: `src/interaction/InteractionSession.ts`
56+
- Runtime and orchestration: `src/runtime/createRuntime.ts`, `src/core/**`
57+
- Browser UI: `web/src/**`
58+
59+
Please prefer:
60+
61+
- targeted changes with tests
62+
- readable code over clever abstractions
63+
- updating docs when behavior or commands change
64+
65+
## Pull request checklist
66+
67+
Before opening a pull request, please make sure you have:
68+
69+
- run `npm run build`
70+
- run `npm test`
71+
- updated docs or screenshots if UI behavior changed
72+
- described user-facing changes and any follow-up work
73+
74+
## Commit and review expectations
75+
76+
- Use clear commit messages.
77+
- Mention affected commands, workflows, or nodes in the pull request description.
78+
- Call out any environment assumptions, especially around Codex login, OpenAI API usage, or Semantic Scholar access.
79+
80+
## Reporting security issues
81+
82+
Please do not report security issues in public GitHub issues. Follow the guidance in `SECURITY.md`.

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 AutoResearch contributors
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.

0 commit comments

Comments
 (0)