@shohojdhara/atomix 0.1.21 → 0.1.24
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/CHANGELOG.md +4 -0
- package/NPM_PUBLISHING.md +221 -0
- package/README.md +50 -124
- package/css.d.ts +0 -0
- package/dist/css/atomix.css +1 -1
- package/dist/js/628.js +1 -0
- package/dist/js/atomix.react.cjs.js +1 -0
- package/dist/js/atomix.react.esm.js +1 -1
- package/dist/js/atomix.react.umd.js +1 -1
- package/dist/js/chunks/cjs/202.6e2b9e63a406ff01b151.js +1 -0
- package/dist/js/chunks/cjs/308.86b2e7ea63bf439e01b4.js +1 -0
- package/dist/js/chunks/cjs/54.54733c458fc7ced6d9ba.js +1 -0
- package/dist/js/chunks/cjs/619.8e6863cb2985a3a109af.js +1 -0
- package/dist/js/chunks/cjs/690.17522d562f7ebe2fa7b4.js +1 -0
- package/dist/js/chunks/cjs/894.6edddf7d4bf7ccb11e25.js +1 -0
- package/dist/js/chunks/cjs/897.74f4c88710fe45c1b9e3.js +1 -0
- package/dist/types/components/Breadcrumb/index.d.ts +2 -3
- package/dist/types/components/River/index.d.ts +1 -1
- package/dist/types/components/Tab/index.d.ts +2 -2
- package/dist/types/components/Toggle/index.d.ts +2 -2
- package/dist/types/components/Tooltip/index.d.ts +2 -3
- package/index.d.ts +3 -0
- package/package.json +38 -86
- package/src/components/Accordion/index.ts +0 -0
- package/src/components/AtomixLogo/index.ts +0 -0
- package/src/components/Button/index.ts +0 -0
- package/src/components/Navigation/Menu/Menu.stories.tsx +0 -0
- package/src/components/Navigation/Nav/Nav.stories.tsx +0 -0
- package/src/components/Navigation/README.md +0 -0
- package/src/components/Navigation/SideMenu/SideMenu.README.md +0 -0
- package/src/components/Navigation/SideMenu/SideMenu.stories.tsx +0 -0
- package/src/components/Navigation/SideMenu/SideMenu.tsx +0 -0
- package/src/components/Navigation/SideMenu/SideMenuItem.tsx +0 -0
- package/src/components/Navigation/SideMenu/SideMenuList.tsx +0 -0
- package/src/components/Navigation/scripts/NavbarInteractions.ts +0 -0
- package/src/components/Navigation/scripts/SideMenu.ts +0 -0
- package/src/components/Navigation/scripts/SideMenuBundle.ts +0 -0
- package/src/components/Navigation/scripts/SideMenuInteractions.ts +0 -0
- package/src/components/Navigation/scripts/bundle.ts +0 -0
- package/src/components/Navigation/scripts/index.ts +0 -0
- package/src/components/PhotoViewer/README.md +0 -0
- package/src/components/index.ts +0 -0
- package/src/docs/atomix-component-guidelines.mdx +0 -0
- package/src/index.ts +10 -5
- package/src/layouts/index.ts +5 -0
- package/src/lib/README.md +0 -0
- package/src/lib/composables/useSideMenu.ts +0 -0
- package/src/lib/index.ts +6 -6
- package/src/styles/01-settings/_settings.animations.scss +7 -2
- package/src/styles/01-settings/_settings.box-shadow.scss +9 -5
- package/src/styles/01-settings/_settings.button.scss +5 -0
- package/src/styles/01-settings/_settings.card.scss +2 -1
- package/src/styles/01-settings/_settings.form.scss +3 -0
- package/src/styles/01-settings/_settings.navbar.scss +1 -0
- package/src/styles/01-settings/_settings.typography.scss +2 -2
- package/src/styles/01-settings/_settings.z-layers.scss +19 -1
- package/src/styles/css-modules.d.ts +308 -0
- package/CONTRIBUTING.md +0 -151
- package/NEXTJS_INTEGRATION.md +0 -389
- package/babel.config.js +0 -58
- package/dist/types/layouts/Grid/Container.d.ts +0 -38
- package/dist/types/layouts/Grid/Grid.d.ts +0 -37
- package/dist/types/layouts/Grid/GridCol.d.ts +0 -64
- package/dist/types/layouts/Grid/Row.d.ts +0 -38
- package/dist/types/layouts/Grid/index.d.ts +0 -8
- package/dist/types/layouts/MasonryGrid/MasonryGrid.d.ts +0 -71
- package/dist/types/layouts/MasonryGrid/MasonryGridItem.d.ts +0 -24
- package/dist/types/layouts/MasonryGrid/index.d.ts +0 -4
- package/dist/types/layouts/index.d.ts +0 -2
- package/dist/types/lib/composables/index.d.ts +0 -30
- package/dist/types/lib/composables/useAccordion.d.ts +0 -30
- package/dist/types/lib/composables/useBadge.d.ts +0 -10
- package/dist/types/lib/composables/useBreadcrumb.d.ts +0 -13
- package/dist/types/lib/composables/useButton.d.ts +0 -11
- package/dist/types/lib/composables/useCallout.d.ts +0 -11
- package/dist/types/lib/composables/useCard.d.ts +0 -8
- package/dist/types/lib/composables/useCheckbox.d.ts +0 -11
- package/dist/types/lib/composables/useDataTable.d.ts +0 -66
- package/dist/types/lib/composables/useDatePicker.d.ts +0 -91
- package/dist/types/lib/composables/useDropdown.d.ts +0 -26
- package/dist/types/lib/composables/useEdgePanel.d.ts +0 -15
- package/dist/types/lib/composables/useForm.d.ts +0 -12
- package/dist/types/lib/composables/useFormGroup.d.ts +0 -10
- package/dist/types/lib/composables/useHero.d.ts +0 -53
- package/dist/types/lib/composables/useInput.d.ts +0 -12
- package/dist/types/lib/composables/useMessages.d.ts +0 -38
- package/dist/types/lib/composables/useModal.d.ts +0 -40
- package/dist/types/lib/composables/useNavbar.d.ts +0 -59
- package/dist/types/lib/composables/usePagination.d.ts +0 -13
- package/dist/types/lib/composables/usePhotoViewer.d.ts +0 -57
- package/dist/types/lib/composables/usePopover.d.ts +0 -30
- package/dist/types/lib/composables/useProgress.d.ts +0 -38
- package/dist/types/lib/composables/useRadio.d.ts +0 -10
- package/dist/types/lib/composables/useRating.d.ts +0 -52
- package/dist/types/lib/composables/useRiver.d.ts +0 -107
- package/dist/types/lib/composables/useSelect.d.ts +0 -10
- package/dist/types/lib/composables/useSideMenu.d.ts +0 -28
- package/dist/types/lib/composables/useSpinner.d.ts +0 -10
- package/dist/types/lib/composables/useTextarea.d.ts +0 -10
- package/dist/types/lib/composables/useTodo.d.ts +0 -18
- package/dist/types/lib/constants/components.d.ts +0 -993
- package/dist/types/lib/constants/index.d.ts +0 -1
- package/dist/types/lib/index.d.ts +0 -6
- package/dist/types/lib/types/components.d.ts +0 -2050
- package/dist/types/lib/types/index.d.ts +0 -1
- package/dist/types/lib/utils/dom.d.ts +0 -26
- package/dist/types/lib/utils/icons.d.ts +0 -20
- package/dist/types/lib/utils/index.d.ts +0 -3
- package/dist/types/lib/utils/useForkRef.d.ts +0 -10
- package/examples/nextjs-example.tsx +0 -271
- package/implementation-guide.md +0 -505
- package/next.config.js +0 -90
- package/postcss.config.js +0 -28
- package/tsconfig.json +0 -74
- package/webpack.config.js +0 -473
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
// CSS Modules type definitions for Atomix components
|
|
2
|
+
|
|
3
|
+
// Global module declarations for CSS files
|
|
4
|
+
declare module '*.module.css' {
|
|
5
|
+
const classes: { readonly [key: string]: string };
|
|
6
|
+
export default classes;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
declare module '*.module.scss' {
|
|
10
|
+
const classes: { readonly [key: string]: string };
|
|
11
|
+
export default classes;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
declare module '*.module.sass' {
|
|
15
|
+
const classes: { readonly [key: string]: string };
|
|
16
|
+
export default classes;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// For regular CSS files (non-module)
|
|
20
|
+
declare module '*.css' {
|
|
21
|
+
const content: string;
|
|
22
|
+
export default content;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
declare module '*.scss' {
|
|
26
|
+
const content: string;
|
|
27
|
+
export default content;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
declare module '*.sass' {
|
|
31
|
+
const content: string;
|
|
32
|
+
export default content;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// Specific interface for Atomix CSS modules
|
|
36
|
+
export interface AtomixCSSModules {
|
|
37
|
+
// Button classes
|
|
38
|
+
'c-btn': string;
|
|
39
|
+
'c-btn--primary': string;
|
|
40
|
+
'c-btn--secondary': string;
|
|
41
|
+
'c-btn--success': string;
|
|
42
|
+
'c-btn--error': string;
|
|
43
|
+
'c-btn--warning': string;
|
|
44
|
+
'c-btn--info': string;
|
|
45
|
+
'c-btn--light': string;
|
|
46
|
+
'c-btn--dark': string;
|
|
47
|
+
'c-btn--sm': string;
|
|
48
|
+
'c-btn--lg': string;
|
|
49
|
+
'c-btn--icon': string;
|
|
50
|
+
'c-btn--rounded': string;
|
|
51
|
+
'c-btn--disabled': string;
|
|
52
|
+
|
|
53
|
+
// Card classes
|
|
54
|
+
'c-card': string;
|
|
55
|
+
'c-card__header': string;
|
|
56
|
+
'c-card__body': string;
|
|
57
|
+
'c-card__footer': string;
|
|
58
|
+
'c-card__title': string;
|
|
59
|
+
'c-card__text': string;
|
|
60
|
+
'c-card__actions': string;
|
|
61
|
+
'c-card__image': string;
|
|
62
|
+
'c-card__icon': string;
|
|
63
|
+
'c-card--row': string;
|
|
64
|
+
'c-card--flat': string;
|
|
65
|
+
'is-active': string;
|
|
66
|
+
'is-flipped': string;
|
|
67
|
+
'is-focused': string;
|
|
68
|
+
'is-clickable': string;
|
|
69
|
+
|
|
70
|
+
// Badge classes
|
|
71
|
+
'c-badge': string;
|
|
72
|
+
'c-badge--primary': string;
|
|
73
|
+
'c-badge--secondary': string;
|
|
74
|
+
'c-badge--success': string;
|
|
75
|
+
'c-badge--error': string;
|
|
76
|
+
'c-badge--warning': string;
|
|
77
|
+
'c-badge--info': string;
|
|
78
|
+
'c-badge--light': string;
|
|
79
|
+
'c-badge--dark': string;
|
|
80
|
+
'c-badge--sm': string;
|
|
81
|
+
'c-badge--lg': string;
|
|
82
|
+
'c-badge__icon': string;
|
|
83
|
+
|
|
84
|
+
// Input classes
|
|
85
|
+
'c-input': string;
|
|
86
|
+
'c-input--sm': string;
|
|
87
|
+
'c-input--lg': string;
|
|
88
|
+
'c-input--textarea': string;
|
|
89
|
+
'is-invalid': string;
|
|
90
|
+
'is-valid': string;
|
|
91
|
+
'is-disabled': string;
|
|
92
|
+
|
|
93
|
+
// Modal classes
|
|
94
|
+
'c-modal': string;
|
|
95
|
+
'c-modal__dialog': string;
|
|
96
|
+
'c-modal__backdrop': string;
|
|
97
|
+
'c-modal__header': string;
|
|
98
|
+
'c-modal__body': string;
|
|
99
|
+
'c-modal__footer': string;
|
|
100
|
+
'c-modal__title': string;
|
|
101
|
+
'c-modal__close': string;
|
|
102
|
+
'is-open': string;
|
|
103
|
+
|
|
104
|
+
// Navigation classes
|
|
105
|
+
'c-navbar': string;
|
|
106
|
+
'c-navbar__container': string;
|
|
107
|
+
'c-navbar__brand': string;
|
|
108
|
+
'c-navbar__collapse': string;
|
|
109
|
+
'c-navbar__toggler': string;
|
|
110
|
+
'c-navbar__toggler-icon': string;
|
|
111
|
+
'c-navbar--fixed': string;
|
|
112
|
+
'c-navbar--fixed-bottom': string;
|
|
113
|
+
'c-navbar--collapsible': string;
|
|
114
|
+
'is-expanded': string;
|
|
115
|
+
|
|
116
|
+
'c-nav': string;
|
|
117
|
+
'c-nav__item': string;
|
|
118
|
+
'c-nav__link': string;
|
|
119
|
+
'c-nav__dropdown-menu': string;
|
|
120
|
+
'c-nav__mega-menu': string;
|
|
121
|
+
'c-nav__icon': string;
|
|
122
|
+
'c-nav--end': string;
|
|
123
|
+
'c-nav--center': string;
|
|
124
|
+
|
|
125
|
+
// Form classes
|
|
126
|
+
'c-form': string;
|
|
127
|
+
'c-form--disabled': string;
|
|
128
|
+
'c-form-group': string;
|
|
129
|
+
'c-form-group__label': string;
|
|
130
|
+
'c-form-group__field': string;
|
|
131
|
+
'c-form-group__helper': string;
|
|
132
|
+
'c-form-group__required': string;
|
|
133
|
+
'c-form-group--sm': string;
|
|
134
|
+
'c-form-group--lg': string;
|
|
135
|
+
'c-form-group--invalid': string;
|
|
136
|
+
'c-form-group--valid': string;
|
|
137
|
+
'c-form-group--disabled': string;
|
|
138
|
+
|
|
139
|
+
// Checkbox and Radio classes
|
|
140
|
+
'c-checkbox': string;
|
|
141
|
+
'c-checkbox__input': string;
|
|
142
|
+
'c-checkbox__label': string;
|
|
143
|
+
'c-checkbox--mixed': string;
|
|
144
|
+
'is-error': string;
|
|
145
|
+
|
|
146
|
+
'c-radio': string;
|
|
147
|
+
'c-radio__input': string;
|
|
148
|
+
'c-radio__label': string;
|
|
149
|
+
|
|
150
|
+
// Select classes
|
|
151
|
+
'c-select': string;
|
|
152
|
+
'c-select__selected': string;
|
|
153
|
+
'c-select__body': string;
|
|
154
|
+
'c-select__panel': string;
|
|
155
|
+
'c-select__items': string;
|
|
156
|
+
'c-select__item': string;
|
|
157
|
+
'c-select__item-label': string;
|
|
158
|
+
'c-select__item-input': string;
|
|
159
|
+
'c-select__toggle-icon': string;
|
|
160
|
+
'c-select--sm': string;
|
|
161
|
+
'c-select--lg': string;
|
|
162
|
+
|
|
163
|
+
// Utility classes
|
|
164
|
+
'u-visually-hidden': string;
|
|
165
|
+
'u-text-center': string;
|
|
166
|
+
'u-text-left': string;
|
|
167
|
+
'u-text-right': string;
|
|
168
|
+
'u-mb-0': string;
|
|
169
|
+
'u-mb-1': string;
|
|
170
|
+
'u-mb-2': string;
|
|
171
|
+
'u-mb-3': string;
|
|
172
|
+
'u-mb-4': string;
|
|
173
|
+
'u-mb-5': string;
|
|
174
|
+
'u-mt-0': string;
|
|
175
|
+
'u-mt-1': string;
|
|
176
|
+
'u-mt-2': string;
|
|
177
|
+
'u-mt-3': string;
|
|
178
|
+
'u-mt-4': string;
|
|
179
|
+
'u-mt-5': string;
|
|
180
|
+
'u-p-0': string;
|
|
181
|
+
'u-p-1': string;
|
|
182
|
+
'u-p-2': string;
|
|
183
|
+
'u-p-3': string;
|
|
184
|
+
'u-p-4': string;
|
|
185
|
+
'u-p-5': string;
|
|
186
|
+
|
|
187
|
+
// Layout classes
|
|
188
|
+
'o-container': string;
|
|
189
|
+
'o-grid': string;
|
|
190
|
+
'o-grid__col': string;
|
|
191
|
+
'o-grid__col--1': string;
|
|
192
|
+
'o-grid__col--2': string;
|
|
193
|
+
'o-grid__col--3': string;
|
|
194
|
+
'o-grid__col--4': string;
|
|
195
|
+
'o-grid__col--5': string;
|
|
196
|
+
'o-grid__col--6': string;
|
|
197
|
+
'o-grid__col--7': string;
|
|
198
|
+
'o-grid__col--8': string;
|
|
199
|
+
'o-grid__col--9': string;
|
|
200
|
+
'o-grid__col--10': string;
|
|
201
|
+
'o-grid__col--11': string;
|
|
202
|
+
'o-grid__col--12': string;
|
|
203
|
+
|
|
204
|
+
// Additional component classes that might be missing
|
|
205
|
+
'c-accordion': string;
|
|
206
|
+
'c-accordion__item': string;
|
|
207
|
+
'c-accordion__header': string;
|
|
208
|
+
'c-accordion__content': string;
|
|
209
|
+
'c-accordion__toggle': string;
|
|
210
|
+
|
|
211
|
+
'c-avatar': string;
|
|
212
|
+
'c-avatar--sm': string;
|
|
213
|
+
'c-avatar--lg': string;
|
|
214
|
+
'c-avatar__image': string;
|
|
215
|
+
'c-avatar__initials': string;
|
|
216
|
+
|
|
217
|
+
'c-breadcrumb': string;
|
|
218
|
+
'c-breadcrumb__item': string;
|
|
219
|
+
'c-breadcrumb__link': string;
|
|
220
|
+
'c-breadcrumb__separator': string;
|
|
221
|
+
|
|
222
|
+
'c-countdown': string;
|
|
223
|
+
'c-countdown__item': string;
|
|
224
|
+
'c-countdown__number': string;
|
|
225
|
+
'c-countdown__label': string;
|
|
226
|
+
|
|
227
|
+
'c-data-table': string;
|
|
228
|
+
'c-data-table__header': string;
|
|
229
|
+
'c-data-table__body': string;
|
|
230
|
+
'c-data-table__row': string;
|
|
231
|
+
'c-data-table__cell': string;
|
|
232
|
+
|
|
233
|
+
'c-datepicker': string;
|
|
234
|
+
'c-datepicker__input': string;
|
|
235
|
+
'c-datepicker__calendar': string;
|
|
236
|
+
|
|
237
|
+
'c-dropdown': string;
|
|
238
|
+
'c-dropdown__toggle': string;
|
|
239
|
+
'c-dropdown__menu': string;
|
|
240
|
+
'c-dropdown__item': string;
|
|
241
|
+
|
|
242
|
+
'c-hero': string;
|
|
243
|
+
'c-hero__content': string;
|
|
244
|
+
'c-hero__title': string;
|
|
245
|
+
'c-hero__subtitle': string;
|
|
246
|
+
|
|
247
|
+
'c-list': string;
|
|
248
|
+
'c-list__item': string;
|
|
249
|
+
'c-list-group': string;
|
|
250
|
+
'c-list-group__item': string;
|
|
251
|
+
|
|
252
|
+
'c-messages': string;
|
|
253
|
+
'c-messages__item': string;
|
|
254
|
+
'c-messages--success': string;
|
|
255
|
+
'c-messages--error': string;
|
|
256
|
+
'c-messages--warning': string;
|
|
257
|
+
'c-messages--info': string;
|
|
258
|
+
|
|
259
|
+
'c-pagination': string;
|
|
260
|
+
'c-pagination__item': string;
|
|
261
|
+
'c-pagination__link': string;
|
|
262
|
+
'c-pagination__prev': string;
|
|
263
|
+
'c-pagination__next': string;
|
|
264
|
+
|
|
265
|
+
'c-popover': string;
|
|
266
|
+
'c-popover__content': string;
|
|
267
|
+
'c-popover__arrow': string;
|
|
268
|
+
|
|
269
|
+
'c-progress': string;
|
|
270
|
+
'c-progress__bar': string;
|
|
271
|
+
'c-progress__label': string;
|
|
272
|
+
|
|
273
|
+
'c-rating': string;
|
|
274
|
+
'c-rating__star': string;
|
|
275
|
+
'c-rating__star--filled': string;
|
|
276
|
+
|
|
277
|
+
'c-spinner': string;
|
|
278
|
+
'c-spinner--sm': string;
|
|
279
|
+
'c-spinner--lg': string;
|
|
280
|
+
|
|
281
|
+
'c-steps': string;
|
|
282
|
+
'c-steps__item': string;
|
|
283
|
+
'c-steps__marker': string;
|
|
284
|
+
'c-steps__content': string;
|
|
285
|
+
|
|
286
|
+
'c-tab': string;
|
|
287
|
+
'c-tab__nav': string;
|
|
288
|
+
'c-tab__item': string;
|
|
289
|
+
'c-tab__content': string;
|
|
290
|
+
'c-tab__panel': string;
|
|
291
|
+
|
|
292
|
+
'c-toggle': string;
|
|
293
|
+
'c-toggle__input': string;
|
|
294
|
+
'c-toggle__slider': string;
|
|
295
|
+
|
|
296
|
+
'c-tooltip': string;
|
|
297
|
+
'c-tooltip__content': string;
|
|
298
|
+
'c-tooltip__arrow': string;
|
|
299
|
+
|
|
300
|
+
'c-upload': string;
|
|
301
|
+
'c-upload__area': string;
|
|
302
|
+
'c-upload__input': string;
|
|
303
|
+
'c-upload__preview': string;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
// Export a default styles object for the main Atomix styles
|
|
307
|
+
declare const styles: AtomixCSSModules;
|
|
308
|
+
export default styles;
|
package/CONTRIBUTING.md
DELETED
|
@@ -1,151 +0,0 @@
|
|
|
1
|
-
# Contributing to Atomix
|
|
2
|
-
|
|
3
|
-
Thank you for your interest in contributing to Atomix! This document provides guidelines and instructions for contributing to the project.
|
|
4
|
-
|
|
5
|
-
## Table of Contents
|
|
6
|
-
|
|
7
|
-
- [Code of Conduct](#code-of-conduct)
|
|
8
|
-
- [Getting Started](#getting-started)
|
|
9
|
-
- [Development Workflow](#development-workflow)
|
|
10
|
-
- [Pull Request Process](#pull-request-process)
|
|
11
|
-
- [Coding Standards](#coding-standards)
|
|
12
|
-
- [Testing](#testing)
|
|
13
|
-
- [Documentation](#documentation)
|
|
14
|
-
|
|
15
|
-
## Code of Conduct
|
|
16
|
-
|
|
17
|
-
We expect all contributors to follow our [Code of Conduct](./CODE_OF_CONDUCT.md). Please read it before participating.
|
|
18
|
-
|
|
19
|
-
## Getting Started
|
|
20
|
-
|
|
21
|
-
### Prerequisites
|
|
22
|
-
|
|
23
|
-
- Node.js (version 16 or higher)
|
|
24
|
-
- npm (version 7 or higher)
|
|
25
|
-
|
|
26
|
-
### Setup
|
|
27
|
-
|
|
28
|
-
1. Fork the repository on GitHub
|
|
29
|
-
2. Clone your fork locally
|
|
30
|
-
```bash
|
|
31
|
-
git clone https://github.com/YOUR-USERNAME/atomix.git
|
|
32
|
-
cd atomix
|
|
33
|
-
```
|
|
34
|
-
3. Install dependencies
|
|
35
|
-
```bash
|
|
36
|
-
npm install
|
|
37
|
-
```
|
|
38
|
-
4. Set up the development environment
|
|
39
|
-
```bash
|
|
40
|
-
npm run dev
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Development Workflow
|
|
44
|
-
|
|
45
|
-
### Branch Organization
|
|
46
|
-
|
|
47
|
-
- `main` - The main development branch
|
|
48
|
-
- `release/*` - Release branches
|
|
49
|
-
- `feature/*` - Feature branches
|
|
50
|
-
- `bugfix/*` - Bug fix branches
|
|
51
|
-
|
|
52
|
-
### Working on Features
|
|
53
|
-
|
|
54
|
-
1. Create a new branch from `main`
|
|
55
|
-
```bash
|
|
56
|
-
git checkout -b feature/your-feature-name
|
|
57
|
-
```
|
|
58
|
-
2. Make your changes
|
|
59
|
-
3. Run tests and linting
|
|
60
|
-
```bash
|
|
61
|
-
npm run test
|
|
62
|
-
npm run lint
|
|
63
|
-
```
|
|
64
|
-
4. Commit your changes with a descriptive commit message
|
|
65
|
-
```bash
|
|
66
|
-
git commit -m "feat: add new feature"
|
|
67
|
-
```
|
|
68
|
-
We follow [Conventional Commits](https://www.conventionalcommits.org/) for commit messages.
|
|
69
|
-
|
|
70
|
-
5. Push your branch to your fork
|
|
71
|
-
```bash
|
|
72
|
-
git push origin feature/your-feature-name
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
## Pull Request Process
|
|
76
|
-
|
|
77
|
-
1. Update the README.md or documentation with details of changes if appropriate
|
|
78
|
-
2. Update the CHANGELOG.md with details of changes
|
|
79
|
-
3. The PR should work with the latest version of the codebase
|
|
80
|
-
4. Include screenshots or animated GIFs in your PR if it includes visual changes
|
|
81
|
-
5. Link any related issues in the PR description
|
|
82
|
-
|
|
83
|
-
## Coding Standards
|
|
84
|
-
|
|
85
|
-
### JavaScript/TypeScript
|
|
86
|
-
|
|
87
|
-
- We use ESLint for linting
|
|
88
|
-
- We follow the Airbnb JavaScript Style Guide with some modifications
|
|
89
|
-
- Use TypeScript for all new code
|
|
90
|
-
- Document public APIs with JSDoc comments
|
|
91
|
-
|
|
92
|
-
### CSS/SCSS
|
|
93
|
-
|
|
94
|
-
- We follow the BEM methodology for CSS naming
|
|
95
|
-
- Use SCSS for all styling
|
|
96
|
-
- Follow the ITCSS architecture for organizing styles
|
|
97
|
-
|
|
98
|
-
### Component Guidelines
|
|
99
|
-
|
|
100
|
-
Please refer to the [Atomix Component Guidelines](./atomix-component-guidelines.md) for detailed information on creating and modifying components.
|
|
101
|
-
|
|
102
|
-
## Testing
|
|
103
|
-
|
|
104
|
-
- Write tests for all new features and bug fixes
|
|
105
|
-
- Run the test suite before submitting a PR
|
|
106
|
-
```bash
|
|
107
|
-
npm run test
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
## Documentation
|
|
111
|
-
|
|
112
|
-
- Update documentation for any changes to the API
|
|
113
|
-
- Use markdown for documentation
|
|
114
|
-
- Include examples for new features
|
|
115
|
-
|
|
116
|
-
## Release Process
|
|
117
|
-
|
|
118
|
-
### Version Management
|
|
119
|
-
|
|
120
|
-
We use semantic versioning for releases. To bump the version:
|
|
121
|
-
|
|
122
|
-
```bash
|
|
123
|
-
# Patch release (bug fixes)
|
|
124
|
-
npm run version:patch
|
|
125
|
-
|
|
126
|
-
# Minor release (new features)
|
|
127
|
-
npm run version:minor
|
|
128
|
-
|
|
129
|
-
# Major release (breaking changes)
|
|
130
|
-
npm run version:major
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### Publishing
|
|
134
|
-
|
|
135
|
-
For release candidates:
|
|
136
|
-
|
|
137
|
-
```bash
|
|
138
|
-
npm run publish:rc
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
For stable releases:
|
|
142
|
-
|
|
143
|
-
```bash
|
|
144
|
-
npm run publish:latest
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
## Questions?
|
|
148
|
-
|
|
149
|
-
If you have any questions, please feel free to open an issue or contact the maintainers.
|
|
150
|
-
|
|
151
|
-
Thank you for contributing to Atomix!
|