@openbox/shared-types 0.5.39 → 0.5.40
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.
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# GitHub Copilot Instructions
|
|
2
|
+
|
|
3
|
+
## Commit Message Format
|
|
4
|
+
Always generate commit messages using Conventional Commits format with these specific types:
|
|
5
|
+
|
|
6
|
+
- **feat**: new features or functionality
|
|
7
|
+
- **fix**: bug fixes and issue resolutions
|
|
8
|
+
- **chore**: maintenance tasks, dependency updates, build changes
|
|
9
|
+
- **refactor**: code restructuring without changing functionality
|
|
10
|
+
- **test**: adding, updating, or fixing tests
|
|
11
|
+
- **wip**: work in progress commits
|
|
12
|
+
|
|
13
|
+
## Format Structure
|
|
14
|
+
```
|
|
15
|
+
<type>[optional scope]: <description>
|
|
16
|
+
|
|
17
|
+
<body>
|
|
18
|
+
|
|
19
|
+
[optional footer]
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Body Requirements
|
|
23
|
+
The body is **required** and should provide a list of changes made in the commit. The list doesn't need to be exhaustive but should give reviewers a clear understanding of what was done:
|
|
24
|
+
|
|
25
|
+
- Use bullet points to list the main changes
|
|
26
|
+
- Focus on the most important modifications
|
|
27
|
+
- Be concise but informative
|
|
28
|
+
- Use present tense verbs
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
feat: add user authentication middleware
|
|
34
|
+
|
|
35
|
+
- Implement JWT token validation
|
|
36
|
+
- Add role-based access control
|
|
37
|
+
- Create middleware for route protection
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
fix: resolve memory leak in data processor
|
|
42
|
+
|
|
43
|
+
- Fix circular reference in data cache
|
|
44
|
+
- Add proper cleanup in destroy method
|
|
45
|
+
- Update memory management in batch processing
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
fix: resolve createSingle test assertions (#123)
|
|
50
|
+
|
|
51
|
+
- Update test expectations for new validation rules
|
|
52
|
+
- Fix mock data to match schema requirements
|
|
53
|
+
- Add missing async/await handling
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
chore: update TypeScript dependencies
|
|
58
|
+
|
|
59
|
+
- Upgrade TypeScript to v5.2.0
|
|
60
|
+
- Update @types/node to latest version
|
|
61
|
+
- Fix type compatibility issues
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
test: add unit tests for auth service
|
|
66
|
+
|
|
67
|
+
- Create tests for login functionality
|
|
68
|
+
- Add validation test cases
|
|
69
|
+
- Mock external authentication providers
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
refactor: simplify error handling logic
|
|
74
|
+
|
|
75
|
+
- Consolidate error classes into single module
|
|
76
|
+
- Remove duplicate error handling code
|
|
77
|
+
- Standardize error response format
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Requirements
|
|
81
|
+
- Use lowercase for type and description
|
|
82
|
+
- Keep description under 50 characters when possible
|
|
83
|
+
- Reference GitHub issues using (#issue-number) format
|
|
84
|
+
- Use present tense ("add" not "added")
|
|
85
|
+
- Don't capitalize first letter of description
|
|
86
|
+
- Don't end description with period
|
|
87
|
+
|
|
88
|
+
## Code Quality
|
|
89
|
+
- Follow existing code patterns and conventions
|
|
90
|
+
- Add appropriate TypeScript types
|
|
91
|
+
- Include JSDoc comments for public methods
|
|
92
|
+
- Write comprehensive tests for new functionality
|
|
93
|
+
- Follow the existing project structure
|
|
@@ -98,21 +98,6 @@ jobs:
|
|
|
98
98
|
env:
|
|
99
99
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
100
100
|
|
|
101
|
-
- name: Create GitHub Release
|
|
102
|
-
if: steps.version-check.outputs.should_publish == 'true'
|
|
103
|
-
uses: actions/create-release@v1
|
|
104
|
-
env:
|
|
105
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
106
|
-
with:
|
|
107
|
-
tag_name: v${{ steps.version-check.outputs.package_version }}
|
|
108
|
-
release_name: Release v${{ steps.version-check.outputs.package_version }}
|
|
109
|
-
body: |
|
|
110
|
-
Automatic release for version ${{ steps.version-check.outputs.package_version }}
|
|
111
|
-
|
|
112
|
-
Published to NPM: https://www.npmjs.com/package/${{ steps.version-check.outputs.package_name }}/v/${{ steps.version-check.outputs.package_version }}
|
|
113
|
-
draft: false
|
|
114
|
-
prerelease: false
|
|
115
|
-
|
|
116
101
|
- name: Version already exists
|
|
117
102
|
if: steps.version-check.outputs.should_publish == 'false'
|
|
118
103
|
run: |
|
package/README.md
CHANGED
|
@@ -31,7 +31,6 @@ This repository includes a GitHub Action workflow that automatically publishes t
|
|
|
31
31
|
- **Build Process**: Install dependencies, run linting, formatting checks, and build the package
|
|
32
32
|
- **Publishing**: Automatically publishes to NPM registry if the version doesn't already exist
|
|
33
33
|
- **Version Management**: Checks if the current package.json version exists on NPM before publishing
|
|
34
|
-
- **Release Creation**: Creates a GitHub release with tag when successfully published
|
|
35
34
|
|
|
36
35
|
#### Setup Requirements
|
|
37
36
|
|
|
@@ -54,7 +53,6 @@ This repository includes a GitHub Action workflow that automatically publishes t
|
|
|
54
53
|
- Download build artifacts
|
|
55
54
|
- Check if version exists on NPM
|
|
56
55
|
- Publish to NPM (if version is new)
|
|
57
|
-
- Create GitHub release (if published successfully)
|
|
58
56
|
- Skip publishing if version already exists
|
|
59
57
|
|
|
60
58
|
#### Manual Publishing
|