Skip to content

Commit f45e58c

Browse files
Merge pull request #6133 from te-ing/te-ing-update-contributing-docs
docs: Fix outdated setup instructions in CONTRIBUTING.md
2 parents 403732b + 1608cdc commit f45e58c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thanks for taking your time to read this. We're thrilled you're reading this bec
44

55
## Testing
66

7-
We have a handful of Cucumber features, but most of our testbed consists of RSpec examples. Please write RSpec examples for new code you create.
7+
We use Jest with React Testing Library for our test suite. Please write tests for new code you create.
88

99
## Submitting changes
1010

@@ -29,13 +29,11 @@ Local development configuration is pretty snappy. Here's how to get set up:
2929

3030
1. Install/use node >=16.0.0
3131
1. Install/use yarn >=4.6.x
32-
1. Run `yarn link` from project root
33-
1. Run `cd docs-site && yarn link react-datepicker`
3432
1. Run `yarn install` from project root
35-
1. Run `yarn build` from project root (at least the first time, this will get you the `dist` directory that holds the code that will be linked to)
36-
1. Run `yarn start` from project root. (This command launches a documentation app and runs it as a simple webserver at http://localhost:5173.)
37-
1. Open new terminal window
38-
1. Run `yarn build-dev` from project root. (This command sets up a development environment that keeps an eye on any file changes. When a file is updated, it auto-builds using the latest code.)
33+
1. Run `yarn build` from project root
34+
1. Run `yarn start` from project root (This command launches a documentation app and runs it as a simple webserver at http://localhost:5173.)
35+
1. Open a new terminal window
36+
1. Run `yarn build-dev` from project root (sets up watch mode that auto-rebuilds on file changes)
3937

4038
You can run `yarn test` to execute the test suite and linters. To help you develop the component we’ve set up some tests that cover the basic functionality (can be found in `/tests`). Even though we’re big fans of testing, this only covers a small piece of the component. We highly recommend you add tests when you’re adding new functionality.
4139

0 commit comments

Comments
 (0)