Skip to content

Commit 6e64267

Browse files
authored
Create CONTRIBUTING.md
1 parent cf3f91c commit 6e64267

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# CONTRIBUTING
2+
3+
Contributions are always welcome, no matter how big or small the contribution. Before contributing, please read the [code of conduct](COC.md).
4+
5+
## TLDR;
6+
7+
```js
8+
> yarn
9+
> yarn dev
10+
```
11+
12+
In another terminal window:
13+
14+
```
15+
> yarn --cwd ./docs && yarn --cwd ./docs dev
16+
```
17+
18+
## Getting Started
19+
20+
1. Fork this repo to your personal GitHub account.
21+
22+
1. Clone your personal fork
23+
24+
```sh
25+
> git clone [email protected]:<username>/viewable.git
26+
```
27+
28+
1. Add upstream as a remote
29+
30+
```sh
31+
> git remote add upstream [email protected]:svelte-plugins/viewable.git
32+
```
33+
34+
35+
1. Install dependencies and watch for changes in source
36+
37+
If you do not have yarn installed, run `npm i -g yarn`
38+
39+
```sh
40+
> yarn && yarn dev
41+
```
42+
43+
1. Install dependencies and start the `docs` server
44+
45+
```sh
46+
> yarn --cwd ./docs && yarn --cwd ./docs dev
47+
```
48+
49+
1. Open the following url http://localhost:3000. That's it!
50+
51+
## Pull Requests
52+
53+
I welcome your pull requests.
54+
55+
1. Fork the repo and create your branch from `main`.
56+
2. If you've added code that should be tested, add tests.
57+
3. If you've changed the API, update the documentation in the [README](README).
58+
4. Ensure the test suite passes.
59+
5. Make sure your code lints.
60+
61+
## License
62+
63+
By contributing to this repository, you agree that your contributions will be licensed
64+
under its [MIT](LICENSE) license.

0 commit comments

Comments
 (0)