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

Commit 6a6c5fc

Browse files
Nikhil-Vatssarthak-sehgal
authored andcommitted
Add guide to contribute in README (#18)
1 parent 4c82645 commit 6a6c5fc

File tree

1 file changed

+50
-3
lines changed

1 file changed

+50
-3
lines changed

README.md

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Generates the scaffold for a BioJS component automatically so you don't have to
55

66
This tool is specifically designed keeping in mind the idea of re-packaging existing components, so you can upgrade your components to BioJS 3 component style without having to re-write your component.
77

8-
## Getting started.
8+
## I. Getting started.
99

1010
Step 0: Install [node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/) (npm is distributed with Node.js- which means that when you download Node.js, you automatically get npm installed on your computer).
1111

@@ -38,7 +38,7 @@ After running this, you will be asked some questions about the details of your p
3838
Once it's complete, look at your new README file for build instructions, and check out `src/index.js`
3939
and `examples/index.html` to get started - there are instructions in the code.
4040

41-
## Description of your Project's Folder Structure
41+
## II. Description of your Project's Folder Structure
4242
Once you complete all the steps mentioned above you will have a project with a folder structure like this -
4343

4444
```bash
@@ -85,7 +85,54 @@ Contains instructions for writing description of your component. You should edit
8585

8686
Other files are starter files for your project. Generally, you do not need to edit these files.
8787

88-
If you face any issue, feel free to contact us at [Gitter](https://gitter.im/yochannah).
88+
If you face any issue, feel free to contact us at [Gitter](https://gitter.im/biojs).
89+
90+
## III. Contribute
91+
92+
To contribute, clone this repository, install yeoman and run the code.
93+
94+
Step 1: Clone the repository.
95+
96+
a) Using HTTPS -
97+
98+
```bash
99+
git clone https://github.com/biojs/generator-biojs-webcomponents.git
100+
```
101+
102+
b) Using SSH -
103+
104+
```bash
105+
git clone [email protected]:biojs/generator-biojs-webcomponents.git
106+
```
107+
108+
Step 2: Go to generator's directory
109+
110+
```bash
111+
cd generator-biojs-webcomponents
112+
```
113+
114+
Step 3: Install yeoman
115+
116+
```bash
117+
npm install -g yo
118+
```
119+
120+
Step 4: Symlink the package
121+
122+
```bash
123+
npm link
124+
```
125+
126+
Step 5: Go out of the generator's directory. Run and test the generator locally.
127+
128+
```bash
129+
cd ..
130+
mkdir test-biojs-generator
131+
cd test-biojs-generator
132+
yo biojs-webcomponents
133+
```
134+
135+
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.
89136

90137
### To-do / roadmap.
91138

0 commit comments

Comments
 (0)