Skip to content

Commit 050bce2

Browse files
Update CONTRIBUTING.md
1 parent 5f6a0e1 commit 050bce2

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,35 @@ To make the contribution process as seamless as possible, follow these steps.
106106

107107
You navigate to the repository on your computer by using File Explorer. The repository files are in `C:\Users\<yourusername>\<repo name>`.
108108

109+
To install dependencies that are necessary for development run,
110+
111+
```cmd
112+
npm install
113+
```
114+
109115
To edit files, open them in an editor of your choice and modify them. To create a new file, use the editor of your choice and save the new file in the appropriate location in your local copy of the repository. While working, save your work frequently.
110116

117+
*Note: Make sure to add unit tests to validate you changes.*
118+
119+
Once you have done with your changes, You have to build and test your changes
120+
To build the library run,
121+
122+
```cmd
123+
npm run build
124+
```
125+
126+
To run tests,
127+
128+
```cmd
129+
npm run test
130+
```
131+
132+
To run linting,
133+
134+
```cmd
135+
npm run lint
136+
```
137+
111138
The files in `C:\Users\<yourusername>\<repo name>` are a working copy of the new branch that you created in your local repository. Changing anything in this folder doesn't affect the local repository until you commit a change. To commit a change to the local repository, type the following commands in GitBash:
112139

113140
git add .

0 commit comments

Comments
 (0)