Skip to content

Commit e0512d1

Browse files
committed
chore: complete project structure in contributing guide
1 parent 5096946 commit e0512d1

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,22 @@ There are some other scripts available in the `scripts` section of the `package.
8282

8383
- **`dist`**: contains built file for distribution. Note this directory is only updated when a release happens; they do not reflect the latest changes in development.
8484

85-
- **`test`**: contains unit tests. They are written with [Mocha](https://mochajs.org/) and run with [Karma](https://karma-runner.github.io/2.0/index.html).
85+
- **`docs`**: contains documentation. Powered by [Vuepress](https://github.com/vuejs/vuepress).
8686

8787
- **`src`**: contains the source code, obviously. The codebase is written in ES2015.
8888

8989
- **`components`**: contains code for the core single-file component (`InfiniteLoading.vue`) and spinner single-file component (`Spinner.vue`).
9090

9191
- **`styles`**: contains code for styles of different spinners, they are written with [Less](http://lesscss.org/).
9292

93-
- **`types`**: contains TypeScript type definitions
93+
- **`config.js`**: contains all the runtime configurations for this plugin.
94+
95+
- **`utils.js`**: contains all the tool functions for this plugin.
96+
97+
- **`index.js`**: entry file, contains plugin `install` API definition and the logic to register `InfiniteLoading` component.
98+
99+
- **`scripts`**: contains all the scripts use to developing, testing, building and deploying documentation.
100+
101+
- **`test`**: contains unit tests. They are written with [Mocha](https://mochajs.org/) and run with [Karma](https://karma-runner.github.io/2.0/index.html).
102+
103+
- **`types`**: contains TypeScript type definitions.

0 commit comments

Comments
 (0)