Skip to content

Commit d446453

Browse files
JeongJaeSoonJeongJaeSoon
authored
Merge pull request JeongJaeSoon#4 from JeongJaeSoon/add/oss-settings
✨ feat: add issue templates, CI/CD workflows, and documentation
2 parents ffef0c3 + 15cab3e commit d446453

File tree

16 files changed

+332
-12
lines changed

16 files changed

+332
-12
lines changed

eslint.config.js renamed to .eslintrc.js

File renamed without changes.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: JeongJaeSoon
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. See error
18+
19+
**Expected behavior**
20+
A clear and concise description of what you expected to happen.
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Environment (please complete the following information):**
26+
- OS: [e.g. macOS 14.0]
27+
- Node.js version: [e.g. 18]
28+
- App version: [e.g. 1.1.0]
29+
30+
**Additional context**
31+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: JeongJaeSoon
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is.
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/SECURITY.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------|
7+
| 1.x | :white_check_mark: |
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability, please email <mailto:[email protected]>.
12+
We will respond as soon as possible and coordinate a fix.

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
open-pull-requests-limit: 10
8+
reviewers:
9+
- "JeongJaeSoon"
10+
assignees:
11+
- "JeongJaeSoon"

‎.github/pull_request_template.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
6+
7+
## Type of change
8+
9+
- [ ] Bug fix
10+
- [ ] New feature
11+
- [ ] Documentation update
12+
- [ ] Other (please describe):
13+
14+
## Checklist
15+
16+
- [ ] My code follows the style guidelines of this project
17+
- [ ] I have performed a self-review of my code
18+
- [ ] I have commented my code, particularly in hard-to-understand areas
19+
- [ ] I have made corresponding changes to the documentation
20+
- [ ] My changes generate no new warnings
21+
- [ ] I have added tests that prove my fix is effective or that my feature works
22+
- [ ] New and existing unit tests pass locally with my changes
23+
24+
## Related Issues
25+
26+
Fixes #

‎.github/workflows/ci.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: macos-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [20, 22, 24]
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v4
20+
21+
- name: Setup Node.js ${{ matrix.node-version }}
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Run linter
31+
run: npm run lint
32+
33+
- name: Run type check
34+
run: npm run typecheck
35+
36+
- name: Build application
37+
run: npm run build
38+
39+
- name: Test build artifacts
40+
run: |
41+
test -d dist
42+
test -f dist/main.js

‎.github/workflows/release.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
jobs:
9+
release:
10+
runs-on: macos-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '18'
20+
cache: 'npm'
21+
registry-url: 'https://registry.npmjs.org'
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
26+
- name: Build application
27+
run: npm run build
28+
29+
- name: Create distributable
30+
run: npm run dist
31+
32+
- name: Publish to npm
33+
run: npm publish
34+
env:
35+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
36+
37+
- name: Create GitHub Release
38+
uses: softprops/action-gh-release@v1
39+
with:
40+
files: release/*
41+
generate_release_notes: true
42+
env:
43+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [1.1.0] - 2025-07-29
6+
### Added
7+
- Added npm package URL to README.md
8+
- Enhanced package.json metadata (homepage, bugs, keywords, files, author)
9+
- Added CI/CD workflows for build, lint, typecheck, and release
10+
- Added documentation: CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md
11+
- Added Dependabot configuration
12+
- Improved README with badges and better formatting
13+
14+
## [1.0.1] - 2025-07-28
15+
### Changed
16+
- Initial public npm release

‎CODE_OF_CONDUCT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment:
10+
- Using welcoming and inclusive language
11+
- Being respectful of differing viewpoints
12+
- Gracefully accepting constructive criticism
13+
14+
Examples of unacceptable behavior:
15+
- Trolling, insulting, or derogatory comments
16+
- Personal or political attacks
17+
- Public or private harassment
18+
19+
## Enforcement
20+
21+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer at <mailto:[email protected]>.

0 commit comments

Comments
 (0)