Skip to content

Commit b4666ad

Browse files
committed
docs: add contributing doc
1 parent db58c2b commit b4666ad

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CONTRIBUTING.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing
2+
3+
Thank you for contributing! There are some guidelines you should know. First, let's get you started.
4+
5+
## Setting up Your Dev Environment
6+
7+
The first step is to fork the repo. Once you've got your own fork, check it out locally.
8+
9+
```
10+
git clone git@github.com:yourusername/nymphjs.git nymphjs
11+
```
12+
13+
Now let's get the repo set up for development.
14+
15+
```
16+
cd nymphjs
17+
18+
# This will take a while as it runs bootstrap.
19+
npm i
20+
```
21+
22+
Now you're set up. If there are package-lock.json files updated after setting up, feel free to reset those changes.
23+
24+
## Testing
25+
26+
When you need to test something that involves one of the bigger DBs, there are DB run scripts called `test:db:run` that will set up a DB running in a docker container in the MySQL and Postgres driver directories. You can start all of them with the `test:db:run` script in the root dir.
27+
28+
Once the DB container is running, you can run the `test` script.
29+
30+
To stop the containers, don't use ctrl+C, instead run the `test:db:stop` script in another terminal window.
31+
32+
### Test Tilmeld Setup App
33+
34+
You can run `node packages/tilmeld-setup/test.mjs` to run a test Tilmeld Setup application available at [http://localhost:8080/user/](http://localhost:8080/user/).
35+
36+
## Commiting Changes
37+
38+
Nymph.js uses Prettier to format code. You should use Prettier after you've edited a file before you commit it. You can set up your editor to run Prettier automatically when you save a file. Also, don't forget the Svelte Prettier plugin.
39+
40+
Nymph.js uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages, and Husky will lint your commit messages when you commit. Please follow the conventional commits format for you commit messages. Please also provide meaningful, informative messages.
41+
42+
Once you've made your change, feel free to open a pull request.
43+
44+
Happy coding, and thanks again for contributing!

0 commit comments

Comments
 (0)