You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,6 +129,43 @@ Run the following command before commiting the changes:
129
129
make lint
130
130
```
131
131
132
+
# Project Directory Structure
133
+
134
+
## Overview of `/src` Directory
135
+
136
+
### actors
137
+
138
+
### assets
139
+
140
+
- Assets are the files that are used in the project. These files can be images, videos, logos or fonts etc. The assets directory is used to store all the assets that are used in the project.
141
+
142
+
### base
143
+
144
+
- Base directory contains all the basic components that are used in the project. These components are the building blocks of the project. The base directory contains the following subdirectories like `Buttons`, `Forms`, `Typography` etc.
145
+
146
+
### constants
147
+
148
+
- Constants directory contains all the constants that are used in the project. These constants can be colors, fonts, breakpoints etc.
149
+
150
+
### custom
151
+
152
+
- Custom directory contains all the custom components using the theme colors.
153
+
154
+
### icons
155
+
156
+
- Icons directory contains all the icons that are used in the project or can be used in any of other projects.
157
+
158
+
### theme
159
+
160
+
- Theme directory contains all the theme related files. The theme directory contains the following subdirectories like:
161
+
-`Colors`- contains all the colors that are used in the project or theme components.
162
+
-`components` - contains all the theme components like `Button`,
163
+
-`Typography` with brand colors.
164
+
-[`typography.ts`](https://github.com/layer5io/sistent/blob/master/src/theme/typography.ts) - contains all the typography related files like `font-size`, `font-family` etc.
165
+
-[`palette.ts`](https://github.com/layer5io/sistent/blob/master/src/theme/palette.ts) - contains all the tokens that are used in the project and used in components.
166
+
167
+
Through the theme directory, we export the SistentThemeProvider which is used to provide the theme to the project.
168
+
132
169
# <aname="maintaining"> Reviews</a>
133
170
134
171
All contributors are invited to review pull requests. See this short video on [how to review a pull request](https://www.youtube.com/watch?v=isLfo7jfE6g&feature=youtu.be).
0 commit comments