Skip to content

Commit 7f2a2d5

Browse files
vsxdvsxd
committed
merge: bring feature/project-init into main
# Conflicts: # README.md
2 parents b1bdb52 + 54080b4 commit 7f2a2d5

File tree

8 files changed

+384
-2
lines changed

8 files changed

+384
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Bug Report
2+
description: Report a defect in SkillHub
3+
title: "[Bug] "
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: What happened?
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: steps
16+
attributes:
17+
label: Steps To Reproduce
18+
description: Include commands, requests, or UI flow
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: expected
23+
attributes:
24+
label: Expected Behavior
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: environment
29+
attributes:
30+
label: Environment
31+
description: Branch, commit, runtime profile, browser, OS, etc.
32+
- type: textarea
33+
id: logs
34+
attributes:
35+
label: Logs Or Screenshots

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Report
4+
url: https://example.invalid/security-contact
5+
about: Do not file public issues for suspected vulnerabilities.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Feature Request
2+
description: Propose a new capability or workflow improvement
3+
title: "[Feature] "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem
11+
description: What user or operator problem does this solve?
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: proposal
16+
attributes:
17+
label: Proposed Solution
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternatives Considered
24+
- type: textarea
25+
id: impact
26+
attributes:
27+
label: Impact
28+
description: Auth, API, migration, deployment, observability, or UX impact

‎.github/pull_request_template.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
3+
- What changed?
4+
- Why is this needed?
5+
6+
## Validation
7+
8+
- [ ] Backend tests passed
9+
- [ ] Frontend typecheck/build passed
10+
- [ ] Smoke test run when relevant
11+
12+
Commands run:
13+
14+
```bash
15+
# paste commands here
16+
```
17+
18+
## Risk
19+
20+
- User-facing impact:
21+
- Deployment or migration impact:
22+
- Rollback approach:
23+
24+
## Notes
25+
26+
- Related issue:
27+
- Follow-up work:

‎CODE_OF_CONDUCT.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Code of Conduct
2+
3+
## Our Standard
4+
5+
Contributors and maintainers are expected to keep discussion technical,
6+
respectful, and constructive.
7+
8+
Examples of expected behavior:
9+
10+
- Focus on the problem, tradeoffs, and evidence.
11+
- Assume good intent, but challenge weak reasoning directly.
12+
- Share actionable feedback.
13+
- Respect different levels of experience and domain knowledge.
14+
15+
Examples of unacceptable behavior:
16+
17+
- Harassment, insults, or personal attacks
18+
- Bad-faith argumentation or repeated hostility
19+
- Publishing private or sensitive information without permission
20+
- Disruptive behavior that blocks productive collaboration
21+
22+
## Enforcement
23+
24+
Project maintainers may remove comments, reject contributions, or restrict
25+
participation for behavior that violates this code of conduct.
26+
27+
Serious or repeated violations may result in a temporary or permanent ban from
28+
project spaces.
29+
30+
## Reporting
31+
32+
Report conduct issues privately to the maintainers through an internal contact
33+
channel. Do not use public issues for personal or sensitive reports.

‎CONTRIBUTING.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing to SkillHub
2+
3+
## Scope
4+
5+
SkillHub is a self-hosted registry for agent skills. Contributions should
6+
preserve the existing architecture and product direction documented in
7+
[`docs/`](./docs).
8+
9+
## Before You Start
10+
11+
- Read [`README.md`](./README.md) for local development commands.
12+
- Check the relevant design docs before changing behavior.
13+
- Open an issue for non-trivial changes before sending a large pull request.
14+
15+
## Development Setup
16+
17+
Prerequisites:
18+
19+
- Docker and Docker Compose
20+
- Java 21
21+
- Node.js and `pnpm`
22+
23+
Start the local stack:
24+
25+
```bash
26+
make dev-all
27+
```
28+
29+
Useful commands:
30+
31+
```bash
32+
make test
33+
make typecheck-web
34+
make build-web
35+
./scripts/smoke-test.sh
36+
```
37+
38+
Stop the stack:
39+
40+
```bash
41+
make dev-all-down
42+
```
43+
44+
## Change Guidelines
45+
46+
- Keep changes focused. Avoid mixing refactors with behavior changes.
47+
- Follow existing module boundaries across `server/`, `web/`, and `docs/`.
48+
- Add or update tests when behavior changes.
49+
- Update docs when APIs, auth flows, deployment, or operator workflows change.
50+
- Prefer backward-compatible changes unless the issue explicitly allows a break.
51+
52+
## Pull Requests
53+
54+
Before opening a pull request, make sure:
55+
56+
- The branch is rebased or merged cleanly from the target branch.
57+
- Relevant backend tests pass.
58+
- Frontend typecheck/build passes when frontend files changed.
59+
- Smoke coverage is updated when operator-facing workflows change.
60+
- The pull request description explains motivation, scope, and rollout impact.
61+
62+
## Commit Style
63+
64+
Conventional-style subjects are preferred, for example:
65+
66+
- `feat(auth): add local account login`
67+
- `fix(ops): align smoke test with csrf flow`
68+
- `docs(deploy): clarify runtime image usage`
69+
70+
## Reporting Security Issues
71+
72+
Do not open public issues for suspected security vulnerabilities.
73+
74+
Report them privately to the maintainers through your internal security process
75+
or a private maintainer contact channel.

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ firewall, with the same polish you'd expect from a public registry.
3333

3434
## Quick Start
3535

36-
Start the full local stack with:
37-
`curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/compose.release.yml -o compose.release.yml && curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/.env.release.example -o .env.release && docker compose --env-file .env.release -f compose.release.yml up -d`
36+
Start the full local stack with: `curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up`
3837

3938
### Prerequisites
4039

@@ -205,6 +204,12 @@ Run it against a local backend:
205204
Contributions are welcome. Please open an issue first to discuss
206205
what you'd like to change.
207206

207+
- Contribution guide: [`CONTRIBUTING.md`](./CONTRIBUTING.md)
208+
- Code of conduct: [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)
209+
210+
- Contribution guide: [`CONTRIBUTING.md`](./CONTRIBUTING.md)
211+
- Code of conduct: [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)
212+
208213
## License
209214

210215
MIT

0 commit comments

Comments
 (0)