odac 0.9.0

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.
Files changed (213) hide show
  1. package/.editorconfig +21 -0
  2. package/.github/workflows/auto-pr-description.yml +49 -0
  3. package/.github/workflows/release.yml +32 -0
  4. package/.github/workflows/test-coverage.yml +58 -0
  5. package/.husky/pre-commit +2 -0
  6. package/.kiro/steering/code-style.md +56 -0
  7. package/.kiro/steering/product.md +20 -0
  8. package/.kiro/steering/structure.md +77 -0
  9. package/.kiro/steering/tech.md +87 -0
  10. package/.prettierrc +10 -0
  11. package/.releaserc.js +134 -0
  12. package/AGENTS.md +84 -0
  13. package/CHANGELOG.md +181 -0
  14. package/CODE_OF_CONDUCT.md +83 -0
  15. package/CONTRIBUTING.md +63 -0
  16. package/LICENSE +661 -0
  17. package/README.md +57 -0
  18. package/SECURITY.md +26 -0
  19. package/bin/candy +10 -0
  20. package/bin/candypack +10 -0
  21. package/cli/index.js +3 -0
  22. package/cli/src/Cli.js +348 -0
  23. package/cli/src/Connector.js +93 -0
  24. package/cli/src/Monitor.js +416 -0
  25. package/core/Candy.js +87 -0
  26. package/core/Commands.js +239 -0
  27. package/core/Config.js +1094 -0
  28. package/core/Lang.js +52 -0
  29. package/core/Log.js +43 -0
  30. package/core/Process.js +26 -0
  31. package/docs/backend/01-overview/01-whats-in-the-candy-box.md +9 -0
  32. package/docs/backend/01-overview/02-super-handy-helper-functions.md +9 -0
  33. package/docs/backend/01-overview/03-development-server.md +79 -0
  34. package/docs/backend/02-structure/01-typical-project-layout.md +39 -0
  35. package/docs/backend/03-config/00-configuration-overview.md +214 -0
  36. package/docs/backend/03-config/01-database-connection.md +60 -0
  37. package/docs/backend/03-config/02-static-route-mapping-optional.md +20 -0
  38. package/docs/backend/03-config/03-request-timeout.md +11 -0
  39. package/docs/backend/03-config/04-environment-variables.md +227 -0
  40. package/docs/backend/03-config/05-early-hints.md +352 -0
  41. package/docs/backend/04-routing/01-basic-page-routes.md +28 -0
  42. package/docs/backend/04-routing/02-controller-less-view-routes.md +43 -0
  43. package/docs/backend/04-routing/03-api-and-data-routes.md +20 -0
  44. package/docs/backend/04-routing/04-authentication-aware-routes.md +48 -0
  45. package/docs/backend/04-routing/05-advanced-routing.md +14 -0
  46. package/docs/backend/04-routing/06-error-pages.md +101 -0
  47. package/docs/backend/04-routing/07-cron-jobs.md +149 -0
  48. package/docs/backend/05-controllers/01-how-to-build-a-controller.md +17 -0
  49. package/docs/backend/05-controllers/02-your-trusty-candy-assistant.md +20 -0
  50. package/docs/backend/05-controllers/03-controller-classes.md +93 -0
  51. package/docs/backend/05-forms/01-custom-forms.md +395 -0
  52. package/docs/backend/05-forms/02-automatic-database-insert.md +297 -0
  53. package/docs/backend/06-request-and-response/01-the-request-object-what-is-the-user-asking-for.md +96 -0
  54. package/docs/backend/06-request-and-response/02-sending-a-response-replying-to-the-user.md +40 -0
  55. package/docs/backend/07-views/01-the-view-directory.md +73 -0
  56. package/docs/backend/07-views/02-rendering-a-view.md +179 -0
  57. package/docs/backend/07-views/03-template-syntax.md +181 -0
  58. package/docs/backend/07-views/03-variables.md +328 -0
  59. package/docs/backend/07-views/04-request-data.md +231 -0
  60. package/docs/backend/07-views/05-conditionals.md +290 -0
  61. package/docs/backend/07-views/06-loops.md +353 -0
  62. package/docs/backend/07-views/07-translations.md +358 -0
  63. package/docs/backend/07-views/08-backend-javascript.md +398 -0
  64. package/docs/backend/07-views/09-comments.md +297 -0
  65. package/docs/backend/08-database/01-database-connection.md +99 -0
  66. package/docs/backend/08-database/02-using-mysql.md +322 -0
  67. package/docs/backend/09-validation/01-the-validator-service.md +424 -0
  68. package/docs/backend/10-authentication/01-user-logins-with-authjs.md +53 -0
  69. package/docs/backend/10-authentication/02-foiling-villains-with-csrf-protection.md +55 -0
  70. package/docs/backend/10-authentication/03-register.md +134 -0
  71. package/docs/backend/10-authentication/04-candy-register-forms.md +676 -0
  72. package/docs/backend/10-authentication/05-session-management.md +159 -0
  73. package/docs/backend/10-authentication/06-candy-login-forms.md +596 -0
  74. package/docs/backend/11-mail/01-the-mail-service.md +42 -0
  75. package/docs/backend/12-streaming/01-streaming-overview.md +300 -0
  76. package/docs/backend/13-utilities/01-candy-var.md +504 -0
  77. package/docs/frontend/01-overview/01-introduction.md +146 -0
  78. package/docs/frontend/02-ajax-navigation/01-quick-start.md +608 -0
  79. package/docs/frontend/02-ajax-navigation/02-configuration.md +370 -0
  80. package/docs/frontend/02-ajax-navigation/03-advanced-usage.md +519 -0
  81. package/docs/frontend/03-forms/01-form-handling.md +420 -0
  82. package/docs/frontend/04-api-requests/01-get-post.md +443 -0
  83. package/docs/frontend/05-streaming/01-client-streaming.md +163 -0
  84. package/docs/index.json +452 -0
  85. package/docs/server/01-installation/01-quick-install.md +19 -0
  86. package/docs/server/01-installation/02-manual-installation-via-npm.md +9 -0
  87. package/docs/server/02-get-started/01-core-concepts.md +7 -0
  88. package/docs/server/02-get-started/02-basic-commands.md +57 -0
  89. package/docs/server/02-get-started/03-cli-reference.md +276 -0
  90. package/docs/server/02-get-started/04-cli-quick-reference.md +102 -0
  91. package/docs/server/03-service/01-start-a-new-service.md +57 -0
  92. package/docs/server/03-service/02-delete-a-service.md +48 -0
  93. package/docs/server/04-web/01-create-a-website.md +36 -0
  94. package/docs/server/04-web/02-list-websites.md +9 -0
  95. package/docs/server/04-web/03-delete-a-website.md +29 -0
  96. package/docs/server/05-subdomain/01-create-a-subdomain.md +32 -0
  97. package/docs/server/05-subdomain/02-list-subdomains.md +33 -0
  98. package/docs/server/05-subdomain/03-delete-a-subdomain.md +41 -0
  99. package/docs/server/06-ssl/01-renew-an-ssl-certificate.md +34 -0
  100. package/docs/server/07-mail/01-create-a-mail-account.md +23 -0
  101. package/docs/server/07-mail/02-delete-a-mail-account.md +20 -0
  102. package/docs/server/07-mail/03-list-mail-accounts.md +20 -0
  103. package/docs/server/07-mail/04-change-account-password.md +23 -0
  104. package/eslint.config.mjs +120 -0
  105. package/framework/index.js +4 -0
  106. package/framework/src/Auth.js +309 -0
  107. package/framework/src/Candy.js +81 -0
  108. package/framework/src/Config.js +79 -0
  109. package/framework/src/Env.js +60 -0
  110. package/framework/src/Lang.js +57 -0
  111. package/framework/src/Mail.js +83 -0
  112. package/framework/src/Mysql.js +575 -0
  113. package/framework/src/Request.js +301 -0
  114. package/framework/src/Route/Cron.js +128 -0
  115. package/framework/src/Route/Internal.js +439 -0
  116. package/framework/src/Route.js +455 -0
  117. package/framework/src/Server.js +15 -0
  118. package/framework/src/Stream.js +163 -0
  119. package/framework/src/Token.js +37 -0
  120. package/framework/src/Validator.js +271 -0
  121. package/framework/src/Var.js +211 -0
  122. package/framework/src/View/EarlyHints.js +190 -0
  123. package/framework/src/View/Form.js +600 -0
  124. package/framework/src/View.js +513 -0
  125. package/framework/web/candy.js +838 -0
  126. package/jest.config.js +22 -0
  127. package/locale/de-DE.json +80 -0
  128. package/locale/en-US.json +79 -0
  129. package/locale/es-ES.json +80 -0
  130. package/locale/fr-FR.json +80 -0
  131. package/locale/pt-BR.json +80 -0
  132. package/locale/ru-RU.json +80 -0
  133. package/locale/tr-TR.json +85 -0
  134. package/locale/zh-CN.json +80 -0
  135. package/package.json +86 -0
  136. package/server/index.js +5 -0
  137. package/server/src/Api.js +88 -0
  138. package/server/src/DNS.js +940 -0
  139. package/server/src/Hub.js +535 -0
  140. package/server/src/Mail.js +571 -0
  141. package/server/src/SSL.js +180 -0
  142. package/server/src/Server.js +27 -0
  143. package/server/src/Service.js +248 -0
  144. package/server/src/Subdomain.js +64 -0
  145. package/server/src/Web/Firewall.js +170 -0
  146. package/server/src/Web/Proxy.js +134 -0
  147. package/server/src/Web.js +451 -0
  148. package/server/src/mail/imap.js +1091 -0
  149. package/server/src/mail/server.js +32 -0
  150. package/server/src/mail/smtp.js +786 -0
  151. package/test/cli/Cli.test.js +36 -0
  152. package/test/core/Candy.test.js +234 -0
  153. package/test/core/Commands.test.js +538 -0
  154. package/test/core/Config.test.js +1435 -0
  155. package/test/core/Lang.test.js +250 -0
  156. package/test/core/Process.test.js +156 -0
  157. package/test/framework/Route.test.js +239 -0
  158. package/test/framework/View/EarlyHints.test.js +282 -0
  159. package/test/scripts/check-coverage.js +132 -0
  160. package/test/server/Api.test.js +647 -0
  161. package/test/server/Client.test.js +338 -0
  162. package/test/server/DNS.test.js +2050 -0
  163. package/test/server/DNS.test.js.bak +2084 -0
  164. package/test/server/Log.test.js +73 -0
  165. package/test/server/Mail.account.test_.js +460 -0
  166. package/test/server/Mail.init.test_.js +411 -0
  167. package/test/server/Mail.test_.js +1340 -0
  168. package/test/server/SSL.test_.js +1491 -0
  169. package/test/server/Server.test.js +765 -0
  170. package/test/server/Service.test_.js +1127 -0
  171. package/test/server/Subdomain.test.js +440 -0
  172. package/test/server/Web/Firewall.test.js +175 -0
  173. package/test/server/Web.test_.js +1562 -0
  174. package/test/server/__mocks__/acme-client.js +17 -0
  175. package/test/server/__mocks__/bcrypt.js +50 -0
  176. package/test/server/__mocks__/child_process.js +389 -0
  177. package/test/server/__mocks__/crypto.js +432 -0
  178. package/test/server/__mocks__/fs.js +450 -0
  179. package/test/server/__mocks__/globalCandy.js +227 -0
  180. package/test/server/__mocks__/http-proxy.js +105 -0
  181. package/test/server/__mocks__/http.js +575 -0
  182. package/test/server/__mocks__/https.js +272 -0
  183. package/test/server/__mocks__/index.js +249 -0
  184. package/test/server/__mocks__/mail/server.js +100 -0
  185. package/test/server/__mocks__/mail/smtp.js +31 -0
  186. package/test/server/__mocks__/mailparser.js +81 -0
  187. package/test/server/__mocks__/net.js +369 -0
  188. package/test/server/__mocks__/node-forge.js +328 -0
  189. package/test/server/__mocks__/os.js +320 -0
  190. package/test/server/__mocks__/path.js +291 -0
  191. package/test/server/__mocks__/selfsigned.js +8 -0
  192. package/test/server/__mocks__/server/src/mail/server.js +100 -0
  193. package/test/server/__mocks__/server/src/mail/smtp.js +31 -0
  194. package/test/server/__mocks__/smtp-server.js +106 -0
  195. package/test/server/__mocks__/sqlite3.js +394 -0
  196. package/test/server/__mocks__/testFactories.js +299 -0
  197. package/test/server/__mocks__/testHelpers.js +363 -0
  198. package/test/server/__mocks__/tls.js +229 -0
  199. package/watchdog/index.js +3 -0
  200. package/watchdog/src/Watchdog.js +156 -0
  201. package/web/config.json +5 -0
  202. package/web/controller/page/about.js +27 -0
  203. package/web/controller/page/index.js +34 -0
  204. package/web/package.json +18 -0
  205. package/web/public/assets/css/style.css +1835 -0
  206. package/web/public/assets/js/app.js +96 -0
  207. package/web/route/www.js +19 -0
  208. package/web/skeleton/main.html +22 -0
  209. package/web/view/content/about.html +65 -0
  210. package/web/view/content/home.html +205 -0
  211. package/web/view/footer/main.html +11 -0
  212. package/web/view/head/main.html +5 -0
  213. package/web/view/header/main.html +14 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,181 @@
1
+ ### ⚙️ Engine Tuning
2
+
3
+ - Modular Config
4
+ - New default web template
5
+
6
+ ### ✨ What's New
7
+
8
+ - add <candy:login> component for zero-config registration
9
+ - add <candy:register> component for zero-config registration
10
+ - Environment variable support
11
+ - **Framework:** Support multiple validation checks per field
12
+ - HTTP2 & Server-Sent Events (SSE) Support
13
+ - Modernize view template syntax with <candy> tags
14
+ - No-Code AJAX Navigation
15
+
16
+ ### 📚 Documentation
17
+
18
+ - Add examples for complex MySQL where conditions
19
+ - Expand and update view system documentation
20
+ - Revamp database docs: connection and queries
21
+
22
+ ### 🛠️ Fixes & Improvements
23
+
24
+ - Added config module to candy debug
25
+ - Improve config force save and migration verification
26
+
27
+
28
+
29
+ ---
30
+
31
+ Powered by [🍭 CandyPack](https://candypack.dev)
32
+
33
+ ### ⚙️ Engine Tuning
34
+
35
+ - Refactor SSL certificate generation and error handling
36
+
37
+ ### ✨ What's New
38
+
39
+ - Development Server Mode
40
+ - **Framework:** Custom Cron Jobs
41
+
42
+ ### 📚 Documentation
43
+
44
+ - Simplify and standardize documentation titles
45
+
46
+ ### 🛠️ Fixes & Improvements
47
+
48
+ - Add CAA record support and default Let's Encrypt CAA
49
+ - Enhance system DNS config to use public resolvers
50
+ - Handle systemd-resolved conflict on DNS port 53
51
+ - Improve external IP detection with multiple fallbacks
52
+ - Log stderr output to log buffer with timestamp
53
+ - Make husky prepare script non-failing
54
+ - Skip rate limiting for localhost in DNS requests
55
+
56
+
57
+
58
+ ---
59
+
60
+ Powered by [🍭 CandyPack](https://candypack.dev)
61
+
62
+ ### 🛠️ Fixes & Improvements
63
+
64
+ - Server Startup
65
+
66
+
67
+
68
+ ---
69
+
70
+ Powered by [🍭 CandyPack](https://candypack.dev)
71
+
72
+ ### Refactor
73
+
74
+ - Improve IMAP and SMTP authentication and TLS handling
75
+
76
+ ### ⚙️ Engine Tuning
77
+
78
+ - Improve error handling for HTTP/HTTPS server startup
79
+ - Refactor documentation files
80
+
81
+ ### ✨ What's New
82
+
83
+ - Added 'candy service delete' command.
84
+ - Added 'candy subdomain delete' command.
85
+ - Added CLI prefix arguments support
86
+ - CLI Mouse Support
87
+ - **cli:** Add Progress-Based Output
88
+
89
+ ### 🛠️ Fixes & Improvements
90
+
91
+ - Fix module instantiation and nullish services handling
92
+ - Limit log and error buffer sizes in Web and Watchdog
93
+
94
+ ---
95
+
96
+ Powered by [🍭 CandyPack](https://candypack.dev)
97
+
98
+ **v**
99
+
100
+ ### ✨ What's New
101
+
102
+ - Added 'candy web delete' command.
103
+ - Added German, Spanish, French, Portuguese, Russian, and Chinese language support for CLI
104
+
105
+ ### 🛠️ Fixes & Improvements
106
+
107
+ - DNS Server Improvements
108
+ - Fixed website creation problem
109
+ - **Framework:** Add error handling for config file parsing
110
+ - IMAP Server Improvements
111
+ - Refactor website creation and config handling
112
+ - **Server:** Logs fixed
113
+ - SMTP Server Improvements
114
+ - Web Server Improvements
115
+
116
+ ---
117
+
118
+ Powered by [🍭 CandyPack](https://candypack.dev)
119
+
120
+ **v**
121
+
122
+ ## [0.5.0](https://github.com/CandyPack/CandyPack/compare/v0.4.1...v0.5.0) (2025-09-02)
123
+
124
+ - add view helper to page and authPage methods [#20](https://https://github.com/CandyPack/CandyPack/pull/20) ([](https://github.com/CandyPack/CandyPack/commit/863eaf35950831dd1166b6b2d0a50f48c19af508)), closes [#20](https://github.com/CandyPack/CandyPack/issues/20)
125
+ - merge branch 'main' into dev-1 ([](https://github.com/CandyPack/CandyPack/commit/5c96b1e0e5e0a3a86172ef6ad047cdf6f0c5c029))
126
+ - merge pull request #14 from CandyPack/doc/update-contribution-guidelines ([](https://github.com/CandyPack/CandyPack/commit/eb92bdf66537c5a973629b99762424e31d8fa3a1)), closes [#14](https://github.com/CandyPack/CandyPack/issues/14)
127
+ - merge pull request #16 from CandyPack/feat/custom-semantic-release-notes ([](https://github.com/CandyPack/CandyPack/commit/3ea998e24c27e03878258ac0de8563223dced2f8)), closes [#16](https://github.com/CandyPack/CandyPack/issues/16)
128
+ - merge pull request #21 from CandyPack/dev-1 ([](https://github.com/CandyPack/CandyPack/commit/ae87fd8d50a226d854a8b85345558d7d5b7e81f9)), closes [#21](https://github.com/CandyPack/CandyPack/issues/21)
129
+ - merge pull request #23 from CandyPack/dev ([](https://github.com/CandyPack/CandyPack/commit/b28a237ea070bc66f9ea3dbc2efa967e4d73ab27)), closes [#23](https://github.com/CandyPack/CandyPack/issues/23)
130
+ - merge pull request #25 from CandyPack/dev ([](https://github.com/CandyPack/CandyPack/commit/b9cb9127d64c80d03c407052124b40da86b7caec)), closes [#25](https://github.com/CandyPack/CandyPack/issues/25)
131
+ - refactor server restart and initialization logic ([](https://github.com/CandyPack/CandyPack/commit/2e7a23fce515b6a6e6fdfb58e91810d558001c66))
132
+
133
+ ### ⚡️ Performance Upgrades
134
+
135
+ - core Process Module ([](https://github.com/CandyPack/CandyPack/commit/59ece15756bfb80a3ce8a430d60106ec8b9cea7e))
136
+
137
+ ### ✨ What's New
138
+
139
+ - **release:** customize semantic-release notes generation ([](https://github.com/CandyPack/CandyPack/commit/70ba94ef010c10609cce69d2dd7fc32eb8ddd157))
140
+ - **server:** new Logging Module ([](https://github.com/CandyPack/CandyPack/commit/70699006a36dbcce1f8de3ad549ee6000cd6e3a1))
141
+ - synchronize main with dev branch ([](https://github.com/CandyPack/CandyPack/commit/654ecd33e9296f3753b95f11568f9d289f0d5a23))
142
+
143
+ ### 🎨 Style
144
+
145
+ - add PR and author attribution to release notes [#17](https://https://github.com/CandyPack/CandyPack/pull/17) ([](https://github.com/CandyPack/CandyPack/commit/8ef3e77edb3fc3f6de4582bacf8c3088f5941b76)), closes [#17](https://github.com/CandyPack/CandyPack/issues/17) [#1234](https://github.com/CandyPack/CandyPack/issues/1234) [#1234](https://github.com/CandyPack/CandyPack/issues/1234)
146
+
147
+ ### 📚 Documentation
148
+
149
+ - add AGENTS.md and update contribution guidelines ([](https://github.com/CandyPack/CandyPack/commit/2ef7dcb125eb9b341ecf209cd6f87dc6e0873389))
150
+ - framework Docs ([](https://github.com/CandyPack/CandyPack/commit/cd7a1cec6ebecc5748bae3ccd0dd934ddf77c3fa))
151
+ - server documentation ([](https://github.com/CandyPack/CandyPack/commit/27eb89a0f9c5d17c0364112743f3a032d2999195))
152
+ - update AGENTS.md with detailed developer guide [#18](https://https://github.com/CandyPack/CandyPack/pull/18) ([](https://github.com/CandyPack/CandyPack/commit/65a05649ea61ac1d29ae73e3f27dabe0d82425cd)), closes [#18](https://github.com/CandyPack/CandyPack/issues/18)
153
+
154
+ ### 🛠️ Fixes & Improvements
155
+
156
+ - add missing conventional-changelog-conventionalcommits dependency [#22](https://https://github.com/CandyPack/CandyPack/pull/22) ([](https://github.com/CandyPack/CandyPack/commit/8f8a64fe3a81a5c9015e62755013d141571e5f0d)), closes [#22](https://github.com/CandyPack/CandyPack/issues/22)
157
+ - **CLI:** fixed CLI Commands ([](https://github.com/CandyPack/CandyPack/commit/44c8ef7a2aca9ebdf82317b20dc3c39728cf2676))
158
+ - **Framework:** no Controller View ([](https://github.com/CandyPack/CandyPack/commit/ae73ae793be0e3b6b6d95eaeb75ba981f0eb49f5))
159
+ - rebooting ([](https://github.com/CandyPack/CandyPack/commit/9ab17df2a39621be0429cc3ffd52f0326dc8c64a))
160
+ - resolve semantic-release configuration and dependency errors [#24](https://https://github.com/CandyPack/CandyPack/pull/24) ([](https://github.com/CandyPack/CandyPack/commit/b6359b4687f1f15cbb1847e82d49a998e74f5dde)), closes [#24](https://github.com/CandyPack/CandyPack/issues/24)
161
+
162
+ ## [0.4.1](https://github.com/CandyPack/CandyPack/compare/v0.4.0...v0.4.1) (2025-08-31)
163
+
164
+ ### Bug Fixes
165
+
166
+ - **server:** Refactor server restart and initialization logic ([#15](https://github.com/CandyPack/CandyPack/issues/15)) ([6cc688e](https://github.com/CandyPack/CandyPack/commit/6cc688ed95212fa73d022e3f2d8e773a17fe299e))
167
+
168
+ # [0.4.0](https://github.com/CandyPack/CandyPack/compare/v0.3.1...v0.4.0) (2025-08-28)
169
+
170
+ ### Bug Fixes
171
+
172
+ - Correct license and supported version in docs ([1af458e](https://github.com/CandyPack/CandyPack/commit/1af458ead8a1a577e8e4c6c45d8cae4ee1432d5c))
173
+ - Update auto-generated PR text to English ([27bab61](https://github.com/CandyPack/CandyPack/commit/27bab61461d65737f95e89737bda06753de3bfc5))
174
+
175
+ ### Features
176
+
177
+ - Add Jest for testing ([4e51bbb](https://github.com/CandyPack/CandyPack/commit/4e51bbb1295d44b14f64e661019ac7a526fa96bb))
178
+ - Add Jest for unit testing and code coverage ([1bfe78e](https://github.com/CandyPack/CandyPack/commit/1bfe78eeabc0af1178ba9bc678ab8a2eaa7d9bf8))
179
+ - add semantic-release ([7a88e9e](https://github.com/CandyPack/CandyPack/commit/7a88e9eb3cee12d6d316c776e7d88e8de6b26c55))
180
+ - add semantic-release with npm publishing ([5c2568d](https://github.com/CandyPack/CandyPack/commit/5c2568dac9ca6284718e087ce67a519a21bfe1c5))
181
+ - Complete project refactor and feature enhancement ([d3bcc19](https://github.com/CandyPack/CandyPack/commit/d3bcc1995af8f0548a0bbd8c0396db6775d4b5cf))
@@ -0,0 +1,83 @@
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, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or advances of any kind
22
+ * Trolling, insulting or derogatory comments, and personal or political attacks
23
+ * Public or private harassment
24
+ * Publishing others' private information, such as a physical or email address, without their explicit permission
25
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
26
+
27
+ ## Enforcement Responsibilities
28
+
29
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32
+
33
+ ## Scope
34
+
35
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36
+
37
+ ## Enforcement
38
+
39
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at security@candypack.dev. All complaints will be reviewed and investigated promptly and fairly.
40
+
41
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42
+
43
+ ## Enforcement Guidelines
44
+
45
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46
+
47
+ ### 1. Correction
48
+
49
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50
+
51
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52
+
53
+ ### 2. Warning
54
+
55
+ **Community Impact**: A violation through a single incident or series of actions.
56
+
57
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58
+
59
+ ### 3. Temporary Ban
60
+
61
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62
+
63
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64
+
65
+ ### 4. Permanent Ban
66
+
67
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68
+
69
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
70
+
71
+ ## Attribution
72
+
73
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
74
+
75
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76
+
77
+ For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78
+
79
+ [homepage]: https://www.contributor-covenant.org
80
+ [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
81
+ [Mozilla CoC]: https://github.com/mozilla/diversity
82
+ [FAQ]: https://www.contributor-covenant.org/faq
83
+ [translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,63 @@
1
+ # Contributing to CandyPack
2
+
3
+ First off, thank you for considering contributing to CandyPack! It's people like you that make CandyPack such a great tool.
4
+
5
+ This project and everyone participating in it is governed by the [CandyPack Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to security@candypack.dev.
6
+
7
+ ## How Can I Contribute?
8
+
9
+ There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into CandyPack itself.
10
+
11
+ ### Reporting Bugs
12
+
13
+ Before creating a bug report, please check the [issues list](https://github.com/CandyPack/CandyPack/issues) to see if the bug has already been reported. If it has, please add a comment to the existing issue instead of creating a new one.
14
+
15
+ When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
16
+
17
+ ### Suggesting Enhancements
18
+
19
+ If you have an idea for a new feature or an improvement to an existing one, please open an issue with the "feature request" label. Provide a clear and detailed explanation of the feature, why it's needed, and how it should work.
20
+
21
+ ### Your First Code Contribution
22
+
23
+ Unsure where to begin contributing to CandyPack? You can start by looking through `good first issue` and `help wanted` issues:
24
+
25
+ * [Good first issues](https://github.com/CandyPack/CandyPack/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code, and a test or two.
26
+ * [Help wanted issues](https://github.com/CandyPack/CandyPack/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which should be a bit more involved than `good first issue` issues.
27
+
28
+ ### Development Workflow
29
+
30
+ Our development process follows a branching model similar to Git Flow. This helps us keep the `main` branch stable and ready for release at all times.
31
+
32
+ 1. **Branching:**
33
+ * All new features or bug fixes should be developed on a feature branch.
34
+ * Create your feature branch from the `dev` branch: `git checkout -b your-feature-name dev`.
35
+ * Never create a feature branch directly from `main`.
36
+
37
+ 2. **Making Changes:**
38
+ * Make your code changes, ensuring you follow the project's coding standards.
39
+ * Add tests for any new code.
40
+ * Ensure all tests pass (`npm test`) and the code lints correctly.
41
+
42
+ 3. **Committing Changes:**
43
+ * This project uses **Conventional Commits**. This is a requirement for our automated release process.
44
+ * Your commit messages must be in the format: `<type>(<scope>): <subject>`.
45
+ * **type:** `feat` (new feature), `fix` (bug fix), `docs`, `style`, `refactor`, `test`, `chore`.
46
+ * **scope:** (Optional) The part of the project you're working on (e.g., `server`, `framework`).
47
+ * Example: `feat(server): add rate limiting to API endpoints`
48
+
49
+ 4. **Submitting a Pull Request:**
50
+ * Once your feature is complete, push your branch to your fork.
51
+ * Open a Pull Request (PR) from your feature branch to the `dev` branch of the main repository.
52
+ * Provide a clear description of the changes in your PR.
53
+ * After your PR is reviewed and merged, you can safely delete your feature branch.
54
+
55
+ The `main` branch is only updated by merging `dev` into it during a new release. Direct pushes or PRs to `main` are not permitted.
56
+
57
+ ## Code Style
58
+
59
+ All JavaScript must adhere to the style defined in the `.prettierrc` file. The linter will automatically check this.
60
+
61
+ ---
62
+
63
+ We look forward to your contributions!