helices 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- helices-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md +49 -0
- helices-0.1.0/.github/ISSUE_TEMPLATE/config.yml +8 -0
- helices-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md +53 -0
- helices-0.1.0/.github/dependabot.yml +14 -0
- helices-0.1.0/.github/pull_request_template.md +47 -0
- helices-0.1.0/.github/workflows/code_checks.yml +59 -0
- helices-0.1.0/.github/workflows/publish.yml +44 -0
- helices-0.1.0/.github/workflows/unit_tests.yml +58 -0
- helices-0.1.0/.gitignore +42 -0
- helices-0.1.0/.pre-commit-config.yaml +60 -0
- helices-0.1.0/.python-version +1 -0
- helices-0.1.0/CODE_OF_CONDUCT.md +128 -0
- helices-0.1.0/CONTRIBUTING.md +24 -0
- helices-0.1.0/LICENSE +201 -0
- helices-0.1.0/PKG-INFO +324 -0
- helices-0.1.0/README.md +109 -0
- helices-0.1.0/assets/logo.svg +124 -0
- helices-0.1.0/pyproject.toml +123 -0
- helices-0.1.0/src/helix/__init__.py +3 -0
- helices-0.1.0/src/helix/agent.py +298 -0
- helices-0.1.0/src/helix/cli.py +167 -0
- helices-0.1.0/src/helix/config.py +179 -0
- helices-0.1.0/src/helix/display.py +148 -0
- helices-0.1.0/src/helix/git.py +123 -0
- helices-0.1.0/src/helix/init.py +101 -0
- helices-0.1.0/src/helix/results.py +216 -0
- helices-0.1.0/src/helix/runner.py +369 -0
- helices-0.1.0/src/helix/templates.py +289 -0
- helices-0.1.0/tests/__init__.py +0 -0
- helices-0.1.0/tests/conftest.py +8 -0
- helices-0.1.0/tests/test_agent.py +376 -0
- helices-0.1.0/tests/test_cli.py +205 -0
- helices-0.1.0/tests/test_config.py +175 -0
- helices-0.1.0/tests/test_display.py +115 -0
- helices-0.1.0/tests/test_git.py +92 -0
- helices-0.1.0/tests/test_init.py +182 -0
- helices-0.1.0/tests/test_results.py +268 -0
- helices-0.1.0/tests/test_runner.py +421 -0
- helices-0.1.0/uv.lock +1323 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: 🐛 Bug Report
|
|
3
|
+
about: Report a bug to help us improve the project
|
|
4
|
+
title: '[BUG] '
|
|
5
|
+
labels: 'bug'
|
|
6
|
+
assignees: ''
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Bug Description
|
|
11
|
+
|
|
12
|
+
<!-- A clear and concise description of what the bug is -->
|
|
13
|
+
|
|
14
|
+
## Steps to Reproduce
|
|
15
|
+
|
|
16
|
+
1.
|
|
17
|
+
2.
|
|
18
|
+
3.
|
|
19
|
+
|
|
20
|
+
**Code snippet (if applicable):**
|
|
21
|
+
```python
|
|
22
|
+
# Your code here
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Expected Behavior
|
|
26
|
+
|
|
27
|
+
<!-- A clear description of what you expected to happen -->
|
|
28
|
+
|
|
29
|
+
## Actual Behavior
|
|
30
|
+
|
|
31
|
+
<!-- A clear description of what actually happened -->
|
|
32
|
+
|
|
33
|
+
## Environment
|
|
34
|
+
|
|
35
|
+
- **OS:** [Windows | MacOS | Linux]
|
|
36
|
+
- **Python Version:**
|
|
37
|
+
- **helices Version:**
|
|
38
|
+
|
|
39
|
+
## Screenshots/Logs
|
|
40
|
+
|
|
41
|
+
<!-- If applicable, add screenshots or error logs -->
|
|
42
|
+
|
|
43
|
+
## Additional Context
|
|
44
|
+
|
|
45
|
+
<!-- Add any other context about the problem here -->
|
|
46
|
+
|
|
47
|
+
## Possible Solution
|
|
48
|
+
|
|
49
|
+
<!-- If you have suggestions on how to fix the bug, please describe them here -->
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
blank_issues_enabled: false
|
|
2
|
+
contact_links:
|
|
3
|
+
- name: 💬 Discussion
|
|
4
|
+
url: https://github.com/VectorInstitute/helix/discussions
|
|
5
|
+
about: Ask questions or discuss ideas with the community
|
|
6
|
+
- name: 📖 Documentation
|
|
7
|
+
url: https://github.com/VectorInstitute/helix#readme
|
|
8
|
+
about: Check the documentation for setup and usage guides
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ✨ Feature Request
|
|
3
|
+
about: Suggest a new feature or enhancement
|
|
4
|
+
title: '[FEATURE] '
|
|
5
|
+
labels: 'enhancement'
|
|
6
|
+
assignees: ''
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Problem Statement
|
|
11
|
+
|
|
12
|
+
<!-- Is your feature request related to a problem? Describe the problem or use case -->
|
|
13
|
+
|
|
14
|
+
## Proposed Solution
|
|
15
|
+
|
|
16
|
+
<!-- A clear description of what you want to happen -->
|
|
17
|
+
|
|
18
|
+
## Alternative Solutions
|
|
19
|
+
|
|
20
|
+
<!-- Describe any alternative solutions or features you've considered -->
|
|
21
|
+
|
|
22
|
+
## Use Cases
|
|
23
|
+
|
|
24
|
+
<!-- Describe specific use cases where this feature would be valuable -->
|
|
25
|
+
-
|
|
26
|
+
-
|
|
27
|
+
-
|
|
28
|
+
|
|
29
|
+
## Implementation Ideas
|
|
30
|
+
|
|
31
|
+
<!-- If you have ideas about how this could be implemented, describe them here -->
|
|
32
|
+
|
|
33
|
+
## Component Impact
|
|
34
|
+
|
|
35
|
+
<!-- Which parts of the system would this feature affect? -->
|
|
36
|
+
- [ ] CLI (`helix init` / `helix run` / `helix status`)
|
|
37
|
+
- [ ] Runner / agent loop
|
|
38
|
+
- [ ] Config schema (`helix.yaml`)
|
|
39
|
+
- [ ] Templates
|
|
40
|
+
- [ ] Documentation
|
|
41
|
+
- [ ] Other
|
|
42
|
+
|
|
43
|
+
## Additional Context
|
|
44
|
+
|
|
45
|
+
<!-- Add any other context, mockups, or screenshots about the feature request here -->
|
|
46
|
+
|
|
47
|
+
## Priority
|
|
48
|
+
|
|
49
|
+
<!-- How important is this feature to you? -->
|
|
50
|
+
- [ ] Nice to have
|
|
51
|
+
- [ ] Would be helpful
|
|
52
|
+
- [ ] Important for my use case
|
|
53
|
+
- [ ] Critical/blocking
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
|
2
|
+
|
|
3
|
+
version: 2
|
|
4
|
+
updates:
|
|
5
|
+
- package-ecosystem: "github-actions"
|
|
6
|
+
directory: "/"
|
|
7
|
+
schedule:
|
|
8
|
+
interval: "daily"
|
|
9
|
+
|
|
10
|
+
# Keep uv dependencies (uv.lock) up to date
|
|
11
|
+
- package-ecosystem: "uv"
|
|
12
|
+
directory: "/"
|
|
13
|
+
schedule:
|
|
14
|
+
interval: "daily"
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
## Summary
|
|
2
|
+
|
|
3
|
+
<!-- Provide a brief description of what this PR does -->
|
|
4
|
+
|
|
5
|
+
## Type of Change
|
|
6
|
+
|
|
7
|
+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
|
|
8
|
+
- [ ] ✨ New feature (non-breaking change that adds functionality)
|
|
9
|
+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
|
10
|
+
- [ ] 📝 Documentation update
|
|
11
|
+
- [ ] 🔧 Refactoring (no functional changes)
|
|
12
|
+
- [ ] ⚡ Performance improvement
|
|
13
|
+
- [ ] 🧪 Test improvements
|
|
14
|
+
- [ ] 🔒 Security fix
|
|
15
|
+
|
|
16
|
+
## Changes Made
|
|
17
|
+
|
|
18
|
+
<!-- List the main changes made in this PR -->
|
|
19
|
+
-
|
|
20
|
+
-
|
|
21
|
+
-
|
|
22
|
+
|
|
23
|
+
## Testing
|
|
24
|
+
|
|
25
|
+
<!-- Describe how you tested these changes -->
|
|
26
|
+
- [ ] Tests pass locally (`uv run pytest tests/`)
|
|
27
|
+
- [ ] Type checking passes (`uv run mypy src/helix/`)
|
|
28
|
+
- [ ] Linting passes (`uv run ruff check src/helix/`)
|
|
29
|
+
- [ ] Manual testing performed (describe below)
|
|
30
|
+
|
|
31
|
+
**Manual testing details:**
|
|
32
|
+
<!-- Describe any manual testing performed -->
|
|
33
|
+
|
|
34
|
+
## Screenshots/Recordings
|
|
35
|
+
|
|
36
|
+
<!-- If applicable, add screenshots or recordings to demonstrate the changes -->
|
|
37
|
+
|
|
38
|
+
## Related Issues
|
|
39
|
+
|
|
40
|
+
<!-- Link any related issues using "Closes #123" or "Relates to #123" -->
|
|
41
|
+
|
|
42
|
+
## Checklist
|
|
43
|
+
|
|
44
|
+
- [ ] Code follows the project's style guidelines
|
|
45
|
+
- [ ] Self-review of code completed
|
|
46
|
+
- [ ] Documentation updated (if applicable)
|
|
47
|
+
- [ ] No sensitive information (API keys, credentials) exposed
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
name: code checks
|
|
2
|
+
permissions:
|
|
3
|
+
contents: read
|
|
4
|
+
pull-requests: write
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
paths:
|
|
11
|
+
- .pre-commit-config.yaml
|
|
12
|
+
- .github/workflows/code_checks.yml
|
|
13
|
+
- '**.py'
|
|
14
|
+
- uv.lock
|
|
15
|
+
- pyproject.toml
|
|
16
|
+
pull_request:
|
|
17
|
+
branches:
|
|
18
|
+
- main
|
|
19
|
+
paths:
|
|
20
|
+
- .pre-commit-config.yaml
|
|
21
|
+
- .github/workflows/code_checks.yml
|
|
22
|
+
- '**.py'
|
|
23
|
+
- uv.lock
|
|
24
|
+
- pyproject.toml
|
|
25
|
+
|
|
26
|
+
jobs:
|
|
27
|
+
code-checks:
|
|
28
|
+
runs-on: ubuntu-latest
|
|
29
|
+
steps:
|
|
30
|
+
- uses: actions/checkout@v6.0.2
|
|
31
|
+
|
|
32
|
+
- name: Install uv
|
|
33
|
+
uses: astral-sh/setup-uv@v7.6.0
|
|
34
|
+
with:
|
|
35
|
+
version: "0.9.11"
|
|
36
|
+
enable-cache: true
|
|
37
|
+
|
|
38
|
+
- name: Set up Python
|
|
39
|
+
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
|
|
40
|
+
with:
|
|
41
|
+
python-version-file: ".python-version"
|
|
42
|
+
|
|
43
|
+
- name: Install the project
|
|
44
|
+
run: uv sync --all-extras --dev
|
|
45
|
+
|
|
46
|
+
- name: Run pre-commit checks
|
|
47
|
+
run: |
|
|
48
|
+
source .venv/bin/activate
|
|
49
|
+
pre-commit run --all-files
|
|
50
|
+
|
|
51
|
+
- name: Seed pip into venv
|
|
52
|
+
run: uv pip install pip
|
|
53
|
+
|
|
54
|
+
- name: pip-audit
|
|
55
|
+
uses: pypa/gh-action-pip-audit@v1.1.0
|
|
56
|
+
with:
|
|
57
|
+
virtual-environment: .venv/
|
|
58
|
+
ignore-vulns: |
|
|
59
|
+
CVE-2026-4539
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
name: publish package
|
|
2
|
+
permissions:
|
|
3
|
+
contents: read
|
|
4
|
+
pull-requests: write
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
tags:
|
|
9
|
+
- "v*"
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
deploy:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v6.0.2
|
|
16
|
+
|
|
17
|
+
- name: Install uv
|
|
18
|
+
uses: astral-sh/setup-uv@v7.6.0
|
|
19
|
+
with:
|
|
20
|
+
version: "0.9.11"
|
|
21
|
+
enable-cache: true
|
|
22
|
+
|
|
23
|
+
- name: Set up Python
|
|
24
|
+
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
|
|
25
|
+
with:
|
|
26
|
+
python-version-file: ".python-version"
|
|
27
|
+
|
|
28
|
+
- name: Install the project
|
|
29
|
+
run: uv sync --all-extras --dev
|
|
30
|
+
|
|
31
|
+
- name: Build package
|
|
32
|
+
run: uv build
|
|
33
|
+
|
|
34
|
+
- name: Publish to PyPI
|
|
35
|
+
uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e
|
|
36
|
+
with:
|
|
37
|
+
user: __token__
|
|
38
|
+
password: ${{ secrets.PYPI_API_TOKEN }}
|
|
39
|
+
|
|
40
|
+
- name: Create GitHub Release
|
|
41
|
+
uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd
|
|
42
|
+
with:
|
|
43
|
+
artifacts: "dist/*"
|
|
44
|
+
generateReleaseNotes: true
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: unit tests
|
|
2
|
+
permissions:
|
|
3
|
+
contents: read
|
|
4
|
+
pull-requests: write
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
paths:
|
|
11
|
+
- .pre-commit-config.yaml
|
|
12
|
+
- .github/workflows/unit_tests.yml
|
|
13
|
+
- .github/workflows/code_checks.yml
|
|
14
|
+
- '**.py'
|
|
15
|
+
- uv.lock
|
|
16
|
+
- pyproject.toml
|
|
17
|
+
pull_request:
|
|
18
|
+
branches:
|
|
19
|
+
- main
|
|
20
|
+
paths:
|
|
21
|
+
- .pre-commit-config.yaml
|
|
22
|
+
- .github/workflows/unit_tests.yml
|
|
23
|
+
- .github/workflows/code_checks.yml
|
|
24
|
+
- '**.py'
|
|
25
|
+
- uv.lock
|
|
26
|
+
- pyproject.toml
|
|
27
|
+
|
|
28
|
+
jobs:
|
|
29
|
+
unit-tests:
|
|
30
|
+
runs-on: ubuntu-latest
|
|
31
|
+
steps:
|
|
32
|
+
- uses: actions/checkout@v6.0.2
|
|
33
|
+
|
|
34
|
+
- name: Install uv
|
|
35
|
+
uses: astral-sh/setup-uv@v7.6.0
|
|
36
|
+
with:
|
|
37
|
+
version: "0.9.11"
|
|
38
|
+
enable-cache: true
|
|
39
|
+
|
|
40
|
+
- name: Set up Python
|
|
41
|
+
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
|
|
42
|
+
with:
|
|
43
|
+
python-version-file: ".python-version"
|
|
44
|
+
|
|
45
|
+
- name: Install the project
|
|
46
|
+
run: uv sync --all-extras --dev
|
|
47
|
+
|
|
48
|
+
- name: Run unit tests
|
|
49
|
+
run: |
|
|
50
|
+
uv run pytest --cov src/helix --cov-report=xml tests
|
|
51
|
+
|
|
52
|
+
- name: Upload coverage to Codecov
|
|
53
|
+
uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2
|
|
54
|
+
with:
|
|
55
|
+
token: ${{ secrets.CODECOV_TOKEN }}
|
|
56
|
+
slug: VectorInstitute/helix
|
|
57
|
+
fail_ci_if_error: false
|
|
58
|
+
verbose: true
|
helices-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*.pyo
|
|
5
|
+
*.pyd
|
|
6
|
+
*.so
|
|
7
|
+
*.egg
|
|
8
|
+
*.egg-info/
|
|
9
|
+
dist/
|
|
10
|
+
build/
|
|
11
|
+
.eggs/
|
|
12
|
+
|
|
13
|
+
# Virtual environments
|
|
14
|
+
.venv/
|
|
15
|
+
venv/
|
|
16
|
+
env/
|
|
17
|
+
|
|
18
|
+
# uv
|
|
19
|
+
.uv/
|
|
20
|
+
|
|
21
|
+
# Testing
|
|
22
|
+
.pytest_cache/
|
|
23
|
+
.coverage
|
|
24
|
+
htmlcov/
|
|
25
|
+
|
|
26
|
+
# Mypy
|
|
27
|
+
.mypy_cache/
|
|
28
|
+
|
|
29
|
+
# Ruff
|
|
30
|
+
.ruff_cache/
|
|
31
|
+
|
|
32
|
+
# Helix session files (untracked by design)
|
|
33
|
+
run.log
|
|
34
|
+
run.pid
|
|
35
|
+
results.tsv
|
|
36
|
+
|
|
37
|
+
# Editor
|
|
38
|
+
.vscode/
|
|
39
|
+
.idea/
|
|
40
|
+
*.swp
|
|
41
|
+
*.swo
|
|
42
|
+
coverage.xml
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
3
|
+
rev: v6.0.0
|
|
4
|
+
hooks:
|
|
5
|
+
- id: trailing-whitespace
|
|
6
|
+
- id: check-ast
|
|
7
|
+
- id: check-builtin-literals
|
|
8
|
+
- id: check-docstring-first
|
|
9
|
+
- id: check-executables-have-shebangs
|
|
10
|
+
- id: debug-statements
|
|
11
|
+
- id: end-of-file-fixer
|
|
12
|
+
- id: mixed-line-ending
|
|
13
|
+
args: [--fix=lf]
|
|
14
|
+
- id: fix-byte-order-marker
|
|
15
|
+
- id: check-merge-conflict
|
|
16
|
+
- id: check-symlinks
|
|
17
|
+
- id: detect-private-key
|
|
18
|
+
- id: check-yaml
|
|
19
|
+
args: [--unsafe]
|
|
20
|
+
- id: check-toml
|
|
21
|
+
|
|
22
|
+
- repo: https://github.com/astral-sh/uv-pre-commit
|
|
23
|
+
rev: 0.9.26
|
|
24
|
+
hooks:
|
|
25
|
+
- id: uv-lock
|
|
26
|
+
|
|
27
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
28
|
+
rev: 'v0.15.8'
|
|
29
|
+
hooks:
|
|
30
|
+
- id: ruff-check
|
|
31
|
+
args: [--fix, --exit-non-zero-on-fix]
|
|
32
|
+
types_or: [python, jupyter]
|
|
33
|
+
- id: ruff-format
|
|
34
|
+
types_or: [python, jupyter]
|
|
35
|
+
|
|
36
|
+
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
37
|
+
rev: v1.19.1
|
|
38
|
+
hooks:
|
|
39
|
+
- id: mypy
|
|
40
|
+
entry: python3 -m mypy --config-file pyproject.toml
|
|
41
|
+
language: system
|
|
42
|
+
types: [python]
|
|
43
|
+
exclude: "tests|examples"
|
|
44
|
+
|
|
45
|
+
- repo: https://github.com/crate-ci/typos
|
|
46
|
+
rev: v1.32.0
|
|
47
|
+
hooks:
|
|
48
|
+
- id: typos
|
|
49
|
+
|
|
50
|
+
ci:
|
|
51
|
+
autofix_commit_msg: |
|
|
52
|
+
[pre-commit.ci] Add auto fixes from pre-commit.com hooks
|
|
53
|
+
|
|
54
|
+
for more information, see https://pre-commit.ci
|
|
55
|
+
autofix_prs: true
|
|
56
|
+
autoupdate_branch: ''
|
|
57
|
+
autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
|
|
58
|
+
autoupdate_schedule: weekly
|
|
59
|
+
skip: [mypy]
|
|
60
|
+
submodules: false
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.12.8
|
|
@@ -0,0 +1,128 @@
|
|
|
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
|
|
10
|
+
and 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
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
|
26
|
+
overall community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
|
31
|
+
advances of any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email
|
|
35
|
+
address, without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
ai_engineering@vectorinstitute.ai.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
|
86
|
+
of actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
|
93
|
+
permanent ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within
|
|
113
|
+
the community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.0, available at
|
|
119
|
+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
122
|
+
enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
+
|
|
124
|
+
[homepage]: https://www.contributor-covenant.org
|
|
125
|
+
|
|
126
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
+
https://www.contributor-covenant.org/faq. Translations are available at
|
|
128
|
+
https://www.contributor-covenant.org/translations.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Contributing to helix
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing to helix!
|
|
4
|
+
|
|
5
|
+
To submit PRs, please fill out the PR template along with the PR. If the PR
|
|
6
|
+
fixes an issue, don't forget to link the PR to the issue!
|
|
7
|
+
|
|
8
|
+
## Pre-commit hooks
|
|
9
|
+
|
|
10
|
+
Once the Python virtual environment is set up, you can run pre-commit hooks using:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
pre-commit run --all-files
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Coding guidelines
|
|
17
|
+
|
|
18
|
+
For code style, we follow the [PEP 8 style guide](https://peps.python.org/pep-0008/).
|
|
19
|
+
|
|
20
|
+
For docstrings we use [numpy format](https://numpydoc.readthedocs.io/en/latest/format.html).
|
|
21
|
+
|
|
22
|
+
We use [ruff](https://docs.astral.sh/ruff/) for code formatting and static analysis,
|
|
23
|
+
and [mypy](https://mypy.readthedocs.io/en/stable/) for type checking. The pre-commit
|
|
24
|
+
hooks will catch errors before you submit a PR.
|