Skip to content

Commit 8885db3

Browse files
ci(docs): add GitHub standards (CI, PR/Issue templates, CODEOWNERS template)
1 parent d2c16c6 commit 8885db3

File tree

6 files changed

+100
-0
lines changed

6 files changed

+100
-0
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# CODEOWNERS
2+
# Add team(s) or bot account(s) here instead of personal names.
3+
# Example:
4+
# * @org/maintainers

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A clear and concise description of what the bug is
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: steps
14+
attributes:
15+
label: Steps To Reproduce
16+
description: Steps to reproduce the behavior
17+
- type: input
18+
id: version
19+
attributes:
20+
label: Version
21+
description: Library/app version if applicable
22+
- type: textarea
23+
id: logs
24+
attributes:
25+
label: Logs
26+
description: Paste relevant logs

.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: false
2+
contact_links: []
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem
9+
description: Is your feature request related to a problem?
10+
- type: textarea
11+
id: solution
12+
attributes:
13+
label: Proposed solution
14+
description: Describe the solution you'd like
15+
- type: textarea
16+
id: alternatives
17+
attributes:
18+
label: Alternatives considered

.github/pull_request_template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Pull Request
2+
3+
Describe the purpose of this change and the problem it solves.
4+
5+
### Type of change
6+
- [ ] Feature
7+
- [ ] Fix
8+
- [ ] Documentation
9+
- [ ] Refactor/Chore
10+
11+
### Checklist
12+
- [ ] Code builds and tests pass locally
13+
- [ ] Documentation updated if needed
14+
- [ ] Follows conventions and style guidelines

.github/workflows/ci.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ "main", "master" ]
6+
pull_request:
7+
branches: [ "main", "master" ]
8+
9+
jobs:
10+
build-test:
11+
runs-on: macos-latest
12+
timeout-minutes: 30
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Show Swift version
18+
run: swift --version || true
19+
20+
- name: Build (SwiftPM if present)
21+
shell: bash
22+
run: |
23+
if [[ -f Package.swift ]]; then
24+
swift build -v
25+
else
26+
echo "No Package.swift, skipping SwiftPM build"
27+
fi
28+
29+
- name: Test (SwiftPM if present)
30+
shell: bash
31+
run: |
32+
if [[ -f Package.swift ]]; then
33+
swift test -v
34+
else
35+
echo "No Package.swift, skipping SwiftPM tests"
36+
fi

0 commit comments

Comments
 (0)