Skip to content

Commit c237c00

Browse files
Update 'README'
1 parent 02d93ea commit c237c00

File tree

1 file changed

+35
-7
lines changed

1 file changed

+35
-7
lines changed

README.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ $ yarn
4747
To run yarn scripts defined in workspaces, run the following.
4848

4949
```sh
50-
$ yarn workspace <workspace name> run <command name>
50+
$ yarn workspace ${workspace_name} run ${command_name}
5151
```
5252

5353
### Dependencies
@@ -56,23 +56,23 @@ To add dependencies, run one of the following. To prevent unexpected behaviors,
5656

5757
```sh
5858
# Add dependencies to the specified workspace
59-
$ yarn workspace <workspace name> add -E <dependencies>
59+
$ yarn workspace ${workspace_name} add -E ${dependencies}
6060

6161
# Add dev dependencies to the specified workspace
62-
$ yarn workspace <workspace name> add -E -D <dependencies>
62+
$ yarn workspace ${workspace_name} add -E -D ${dependencies}
6363

6464
# Add dev dependencies to the workspaces root
65-
$ yarn add -E -D -W <dependencies>
65+
$ yarn add -E -D -W ${dependencies}
6666
```
6767

6868
To remove dependencies, run one of the following.
6969

7070
```sh
7171
# Remove dependencies from the specified workspace
72-
$ yarn workspace <workspace name> remove <dependencies>
72+
$ yarn workspace ${workspace_name} remove ${dependencies}
7373

7474
# Remove dependencies from the workspaces root
75-
$ yarn remove -W <dependencies>
75+
$ yarn remove -W ${dependencies}
7676
```
7777

7878
### Documentation
@@ -85,4 +85,32 @@ $ yarn run docs
8585

8686
## 🔥 How to Contribute
8787

88-
Feel free to create new issues from [here](https://github.com/jcam1/sdks/issues/new/choose) to propose/request new features or report bugs.
88+
We appreciate your interest to contribute to this project! Please read the following steps to see how to contribute to this project.
89+
90+
### 1. Create an Issue
91+
92+
The first thing to do is to create a new issue. Feel free to create new issues from [here](https://github.com/jcam1/sdks/issues/new/choose) to propose/request new features or report bugs.
93+
94+
### 2. Clone This Repository
95+
96+
Next, clone this repo. Our default branch is `develop`.
97+
98+
```sh
99+
$ git clone --recursive https://github.com/jcam1/sdks.git
100+
```
101+
102+
### 3. Checkout to a New Branch
103+
104+
You then need to checkout to a new branch (name whatever you would like) from the cloned `develop` branch.
105+
106+
```sh
107+
$ git checkout -b ${your_branch_name}
108+
```
109+
110+
### 4. Write Code
111+
112+
Now, write code to implement the proposed features and/or to fix bugs.
113+
114+
### 5. Open a Pull Request
115+
116+
Finally, open a new PR from your branch to `develop` branch to describe what you'll have done.

0 commit comments

Comments
 (0)