Skip to content

Commit 6e13cdd

Browse files
XuPeng-SHXuPeng-SH
committed
update for ci
1 parent c10f46b commit 6e13cdd

8 files changed

Lines changed: 193 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: [kind/bug]
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for the same bug?
10+
description: Please check if an issue already exists.
11+
options:
12+
- label: I have checked the existing issues.
13+
required: true
14+
- type: input
15+
attributes:
16+
label: Environment (optional)
17+
description: OS, Python version, Memoria version, embedding provider.
18+
placeholder: e.g. macOS 14, Python 3.11, memoria 0.1.2, local embedding
19+
validations:
20+
required: false
21+
- type: textarea
22+
attributes:
23+
label: Actual behavior
24+
description: What happened.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Expected behavior
30+
description: What you expected.
31+
validations:
32+
required: false
33+
- type: textarea
34+
attributes:
35+
label: Steps to reproduce
36+
render: Markdown
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: Additional information
42+
description: Logs, errors, or other context.
43+
validations:
44+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
blank_issues_enabled: true
2+
contact_links: []

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Documentation
2+
description: Report a docs problem or suggest new content
3+
title: "[Docs]: "
4+
labels: [kind/docs]
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue about this?
10+
options:
11+
- label: I have checked the existing issues.
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Describe the issue
16+
render: Markdown
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Additional information
22+
validations:
23+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature Request
2+
description: Suggest a new feature or capability
3+
title: "[Feature]: "
4+
labels: [kind/feature]
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for the same feature?
10+
description: Please check if an issue already exists.
11+
options:
12+
- label: I have checked the existing issues.
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Is your feature request related to a problem?
17+
render: Markdown
18+
validations:
19+
required: false
20+
- type: textarea
21+
attributes:
22+
label: Describe the feature you'd like
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Implementation / design notes (optional)
28+
render: Markdown
29+
validations:
30+
required: false
31+
- type: textarea
32+
attributes:
33+
label: Additional information
34+
validations:
35+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Question
2+
description: Ask a question not covered by other templates
3+
title: "[Question]: "
4+
labels: [kind/question]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Before asking, please search open/closed issues and check the README/docs.
11+
- type: textarea
12+
attributes:
13+
label: Your question
14+
validations:
15+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## What type of PR is this?
2+
3+
- [ ] feat (new feature)
4+
- [ ] fix (bug fix)
5+
- [ ] docs (documentation)
6+
- [ ] style (formatting, no code change)
7+
- [ ] refactor (code change that neither fixes a bug nor adds a feature)
8+
- [ ] perf (performance improvement)
9+
- [ ] test (adding or updating tests)
10+
- [ ] chore (maintenance, tooling)
11+
- [ ] build / ci (build or CI changes)
12+
13+
## Which issue(s) this PR fixes
14+
15+
Fixes #
16+
17+
## What this PR does / why we need it

‎.github/workflows/pr-title.yml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Validate PR title (Conventional Commits style).
12
name: PR Title
23

34
on:
@@ -12,12 +13,23 @@ jobs:
1213
- name: Validate title
1314
env:
1415
TITLE: ${{ github.event.pull_request.title }}
16+
# Conventional Commits: type(scope?): description
17+
# Allowed types: feat, fix, docs, style, refactor, perf, test, chore, build, ci, revert
1518
PATTERN: '^(feat|fix|docs|style|refactor|perf|test|chore|build|ci|revert)(\([a-z0-9-]+\))?!?:\s+.+'
1619
run: |
1720
if echo "$TITLE" | grep -qE "$PATTERN"; then
1821
echo "✅ PR title OK: $TITLE"
1922
else
2023
echo "::error::Invalid PR title! Must follow Conventional Commits format."
21-
echo "Examples: feat(memory): add branch support | fix: correct rollback logic"
24+
echo ""
25+
echo "✅ Examples:"
26+
echo " feat(memory): add branch support"
27+
echo " fix(embedding): correct dimension mismatch on local provider"
28+
echo " docs: update quick start guide"
29+
echo " ci: add static checks workflow"
30+
echo ""
31+
echo "❌ Your title: '$TITLE'"
32+
echo ""
33+
echo "📚 Learn more: https://www.conventionalcommits.org"
2234
exit 1
2335
fi

‎.github/workflows/static-checks.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Static Checks
2+
3+
on:
4+
push:
5+
branches: [main, develop]
6+
pull_request:
7+
branches: [main, develop]
8+
9+
jobs:
10+
lint:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-python@v5
15+
with:
16+
python-version: "3.11"
17+
- uses: actions/cache@v4
18+
with:
19+
path: ~/.cache/pip
20+
key: ${{ runner.os }}-pip-check-${{ hashFiles('pyproject.toml') }}
21+
restore-keys: ${{ runner.os }}-pip-check-
22+
- name: Install dependencies
23+
run: pip install -e ".[dev]"
24+
- name: Run ruff
25+
run: ruff check memoria/ tests/
26+
- name: Check formatting
27+
run: ruff format --check memoria/ tests/
28+
29+
type-check:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- uses: actions/setup-python@v5
34+
with:
35+
python-version: "3.11"
36+
- uses: actions/cache@v4
37+
with:
38+
path: ~/.cache/pip
39+
key: ${{ runner.os }}-pip-check-${{ hashFiles('pyproject.toml') }}
40+
restore-keys: ${{ runner.os }}-pip-check-
41+
- name: Install dependencies
42+
run: pip install -e ".[dev]"
43+
- name: Run mypy
44+
run: mypy memoria/

0 commit comments

Comments
 (0)