Skip to content

Commit 3b19c44

Browse files
committed
Add contribution guidelines
1 parent 1429cd6 commit 3b19c44

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
Thanks for your interest in `chakra-react-select`! All forms of contribution are
4+
welcome, from issue reports to PRs and documentation / write-ups.
5+
6+
Before you open a PR:
7+
8+
- In development, run `npm run install:all` to setup the dependencies for the
9+
core package and the demo.
10+
- Run `npm run dev` to build (and watch) the package source, as well as run the
11+
demo project which can be viewed at http://localhost:5152.
12+
- Please ensure all the examples work correctly after your change.
13+
- Also run `npm run lint` to ensure that the change meets the projects code
14+
style setup.
15+
- Make sure there's an issue open for any work you take on and intend to submit
16+
as a pull request - it helps core members review your concept and direction
17+
early and is a good way to discuss what you're planning to do.
18+
- If you open an issue and are interested in working on a fix, please let us
19+
know. We'll help you get started, rather than inadvertently doubling up on
20+
your hard work.
21+
- All new features and changes need documentation. If you don't have time to
22+
write any, leave a note in your PR.

demo/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"type": "module",
66
"scripts": {
77
"build": "tsc -b && vite build",
8-
"dev": "vite",
8+
"dev": "vite --port=5152",
99
"lint": "eslint .",
1010
"preview": "vite preview"
1111
},

0 commit comments

Comments
 (0)