Skip to content

Commit eb1e1cb

Browse files
authored
Create CONTRIBUTING.md
1 parent 1a24658 commit eb1e1cb

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to `react-tailwindcss-datepicker`! Please take a moment to review this document **before submitting a pull request**.
4+
5+
- [Pull requests](#pull-requests)
6+
- [Installation](#installation)
7+
- [Coding standards](#coding-standards)
8+
- [Running playground](#running-playgrounds)
9+
- [Before you make a Pull Request](#before-you-make-a-pull-request)
10+
11+
## Pull requests
12+
13+
**Please ask first before starting work on any significant new features.**
14+
15+
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create [an issue](https://github.com/onesine/react-tailwindcss-datepicker/issues) to first discuss any significant new features.
16+
17+
## Installation
18+
19+
You only require a `yarn install` in the root directory to install everything you need.
20+
21+
```sh
22+
yarn install
23+
```
24+
25+
## Coding standards
26+
27+
We use `prettier` for making sure that the codebase is formatted consistently.
28+
To automatically fix any style violations in your code, you can run:
29+
30+
**Using yarn**
31+
32+
```sh
33+
yarn pret:fix
34+
```
35+
36+
**Using npm**
37+
38+
```sh
39+
npm pret:fix
40+
```
41+
42+
## Running playground
43+
44+
We currently use `next.js` as server for live testing.
45+
46+
You can run the `dev` script and open your browser to `http://localhost:8888`.
47+
48+
See complete `props` usage in `pages/index.js` file.
49+
50+
**Using yarn**
51+
52+
```sh
53+
yarn dev
54+
```
55+
56+
**Using npm**
57+
58+
```sh
59+
npm dev
60+
```
61+
62+
## Before you make a Pull Request
63+
64+
We recommend to run these scripts in sequence before you make your commit message amd open a Pull Request
65+
66+
**Let's clean the code first**
67+
```sh
68+
yarn pret:fix
69+
```
70+
71+
**Test a build of your changes**
72+
```sh
73+
yarn build
74+
75+
```
76+

0 commit comments

Comments
 (0)