keen-builder 1.0.10 → 1.0.12
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.
- package/dist/index.cjs +1 -1
- package/package.json +2 -2
- package/readme.md +80 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "keen-builder",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.12",
|
|
4
4
|
"main": "dist/index.cjs",
|
|
5
5
|
"module": "./dist/index.mjs",
|
|
6
6
|
"type": "module",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
},
|
|
14
14
|
"repository": {
|
|
15
15
|
"type": "git",
|
|
16
|
-
"url": "git+https://github.com/
|
|
16
|
+
"url": "git+https://github.com/Keen-Agents/keen-project-watch-builder-pkg.git"
|
|
17
17
|
},
|
|
18
18
|
"files": [
|
|
19
19
|
"dist/**"
|
package/readme.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# KEEN PROJECT WATCH BUILDER PACKAGE
|
|
2
|
+
|
|
3
|
+
> **KEEN PROJECT WATCH BUILDER PKG** is an npm package for creating and deploying **Keen Agents Projects** to a cloud server.
|
|
4
|
+
> This repository hosts the **Build version** of the package.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 🚀 Overview
|
|
9
|
+
|
|
10
|
+
This package streamlines the process of creating, building, and deploying Keen Agents Projects to the cloud.
|
|
11
|
+
It comes preconfigured with modern developer tools and practices:
|
|
12
|
+
|
|
13
|
+
- **Husky hooks** for Git workflow automation
|
|
14
|
+
- **Prettier** for code style and formatting
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 🛠️ Deployment Process
|
|
19
|
+
|
|
20
|
+
> Get the **dist** folder from project **keen-project-watch-builder**
|
|
21
|
+
> Paste the **dist** in this project
|
|
22
|
+
> Authenticate in **npmjs** and publish the package with access **public**
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
npm publish --access public
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 📝 Code Standards
|
|
29
|
+
|
|
30
|
+
We use **Prettier** to maintain consistent code style (spacing, formatting).
|
|
31
|
+
|
|
32
|
+
For the best experience:
|
|
33
|
+
|
|
34
|
+
- Install the Prettier VS Code plugin
|
|
35
|
+
- Make sure code is formatted before committing
|
|
36
|
+
|
|
37
|
+
## 🌿 Branching Strategy
|
|
38
|
+
|
|
39
|
+
Branch names must follow one of these formats:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
- feature/KWBP-<NUMBER>
|
|
43
|
+
- fix/KWBP-<NUMBER>
|
|
44
|
+
- hotfix/KWBP-<NUMBER>
|
|
45
|
+
- remove/KWBP-<NUMBER>
|
|
46
|
+
- release/KWBP-<NUMBER>
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Where `<NUMBER>` is the ticket number.
|
|
50
|
+
|
|
51
|
+
## 📝 Commit Messages
|
|
52
|
+
|
|
53
|
+
Each commit message must follow this format:
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
KWBP-<NUMBER>:<ADD|FIX|DELETE>: <MESSAGE>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
NUMBER: Ticket number
|
|
61
|
+
|
|
62
|
+
ADD: A new feature
|
|
63
|
+
|
|
64
|
+
FIX: A feature was fixed
|
|
65
|
+
|
|
66
|
+
DELETE: Code cleaned or removed
|
|
67
|
+
|
|
68
|
+
MESSAGE: Short description of the change
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Example:
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
KWBP-123:ADD: Version 1.0.1
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## 🔀 Pull Requests
|
|
78
|
+
|
|
79
|
+
- After pushing, create a PR to the development branch
|
|
80
|
+
- A minimum of 2 reviewers must approve before merging
|