Skip to content

Commit 8252b2d

Browse files
committed
docs: update contributing guidelines
1 parent 6de2385 commit 8252b2d

File tree

5 files changed

+7
-6
lines changed

5 files changed

+7
-6
lines changed

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The following is a set of guidelines for contributing to TOAST UI. These are mos
66

77
## Reporting Bugs
88

9-
Bugs are tracked as GitHub issues. Search the list and try to reproduce on [demo](https://nhn.github.io/tui.calendar/latest/tutorial-example00-basic) before you create an issue. When you create an issue, please provide the following information by filling in the template.
9+
Bugs are tracked as [GitHub issues](https://github.com/nhn/tui.calendar/issues). Search the issue list and try to reproduce on [demo](https://nhn.github.io/tui.calendar/latest/tutorial-00-calendar-app) before you create an issue. When you create an issue, please provide the following information by filling in the template.
1010

1111
Explain the problem and include additional details to help maintainers reproduce the problem:
1212

@@ -45,7 +45,7 @@ Unsure where to begin contributing to TOAST UI? You can start by looking through
4545

4646
- Set up your development environment
4747
- Make change from a right branch
48-
- Be sure the code passes `npm run lint`, `npm run test`
48+
- Be sure the code passes `npm run lint`, `npm run test`, `npm run test:playwright`
4949
- Make a pull request
5050

5151
### Development environment
@@ -54,6 +54,7 @@ Unsure where to begin contributing to TOAST UI? You can start by looking through
5454
- Checkout to the right branch
5555
- Install dependencies by `npm install`
5656
- Start development by `npm run develop`
57+
- For wrappers, `npm run develop --workspace @toast-ui/react-calendar` or `npm run develop --workspace @toast-ui/vue-calendar`
5758

5859
### Make changes
5960

apps/calendar/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Run npm scripts and develop yourself with the following process.
151151

152152
### Setup
153153

154-
Fork `develop` branch into your personal repository.
154+
Fork `main` branch into your personal repository.
155155
Clone it to local computer. Install node modules.
156156
Before starting development, you should check to have any errors.
157157

apps/react-calendar/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Run npm scripts and develop yourself with the following process.
8282

8383
### Setup
8484

85-
Fork `develop` branch into your personal repository.
85+
Fork `main` branch into your personal repository.
8686
Clone it to local computer. Install node modules.
8787
Before starting development, you should check to have any errors.
8888

apps/vue-calendar/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Run npm scripts and develop yourself with the following process.
116116

117117
### Setup
118118

119-
Fork `develop` branch into your personal repository.
119+
Fork `main` branch into your personal repository.
120120
Clone it to local computer. Install node modules.
121121
Before starting development, you should check to have any errors.
122122

apps/vue-calendar/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
],
4646
"scripts": {
4747
"lint": "eslint .",
48-
"dev": "vite",
48+
"develop": "vite",
4949
"build": "rimraf dist/ && concurrently 'npm:build:*'",
5050
"build:modern": "vite build && vite build --mode minify",
5151
"build:ie11": "vite build --mode ie11 && vite build --mode ie11_minify",

0 commit comments

Comments
 (0)