Skip to content
This repository was archived by the owner on Mar 30, 2021. It is now read-only.

Commit 70d7a64

Browse files
committed
Updates contributing docs
1 parent 4c745fd commit 70d7a64

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,71 @@ yo biojs-webcomponents
5050

5151
Note: If you have installed the generator-biojs-webcomponents globally, there is no need to worry, this method will still work. You do not need to uninstall anything.
5252

53+
### About the project
54+
55+
The project directory has the following structure -
56+
57+
```bash
58+
├── __tests__
59+
│ └────── app.js
60+
├── .github
61+
│ └────── issue_template.md
62+
│ └────── pull_request_template.md
63+
├── generators
64+
│ └────── app
65+
│ └────── templates
66+
| | ├── dev
67+
| | │ └────── serve.js
68+
| | ├── examples
69+
| | │ └────── index.html
70+
| | ├── img
71+
| | │ └────── favicon.png
72+
| | ├── node_modules
73+
| | │ ├────── modules
74+
| | ├── src
75+
| | │ ├────── index.js
76+
| | │ └────── style.less
77+
| | ├── index.html
78+
| | ├── LICENSE
79+
| | ├── package.json
80+
| | ├── package-lock.json
81+
| | ├── README.md
82+
| | └── webpack.config.js
83+
| |
84+
│ └────── index.js
85+
│ └────── validator.js
86+
├── node_modules
87+
│ ├────── modules
88+
├── .editorconfig
89+
├── .eslintignore
90+
├── .gitattributes
91+
├── .gitignore
92+
├── .travis.yml
93+
├── .yo-rc.json
94+
├── .CONTRIBUTING.md
95+
├── LICENSE
96+
├── package-lock.json
97+
├── package.json
98+
└── README.md
99+
```
100+
101+
#### __tests__
102+
Contains the test file - app.js which has all the tests for the generator.
103+
104+
#### .github
105+
Contains templates for GitHub issues and pull requests, make sure to follow these when you submit an issue/PR.
106+
107+
#### generators
108+
Contains all the code for generator.
109+
110+
1. app/templates - Contains all the templates which are generated whenever any user runs the generator. Read the directory structure and the purpose of each folder inside the templates folder [here](README.md##ii-description-of-your-projects-folder-structure).
111+
112+
2. app/index.js - Contains all the initializing code, prompts, writing code which actually uses the [templates](generators/app/templates) to generate the web-component project and installs required dependencies.
113+
114+
3. app/validator.js - Contains the validator functions for the prompts which checks user inputs and also performs other functions like copying the build file, installing the component as npm package, downloading the build file from npm package and validating npm package's version.
115+
116+
All the other files are self explanatory.
117+
53118
### To-do / roadmap.
54119

55120
See [issues](issues) for more details - we still need the following:

0 commit comments

Comments
 (0)