Skip to content
This repository was archived by the owner on Jan 25, 2024. It is now read-only.

Commit 45ac9e2

Browse files
adding contributing
1 parent eb829e5 commit 45ac9e2

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# create-nteract-app
22

3-
[![CircleCI](https://circleci.com/gh/nteract/create-nteract-app/tree/master.svg?style=svg)](https://circleci.com/gh/nteract/create-nteract-app/tree/master)
3+
[![CircleCI](https://circleci.com/gh/nteract/create-nteract-app/tree/master.svg?style=svg)](https://circleci.com/gh/nteract/create-nteract-app/tree/master) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
44

55
> Create an nteractive application backed by next.js, mybinder and react with zero configuration.
66
@@ -33,12 +33,12 @@ Now, navigate to [http://localhost:3000/](http://localhost:3000/) and you should
3333
An app bootstrapped with `create-nteract-app` comes with:
3434

3535
- [@nteract](https://github.com/nteract) components for interactive computing apps/pages
36-
- automatic webpack and babel configuration through next.js
36+
- automatic webpack and babel configuration through [next.js](https://nextjs.org/)
3737
- live hot reloading
38-
- mdx
39-
- Every .js or .md file in `./pages` becomes a route that gets automatically processed and rendered!
38+
- [mdx](https://mdxjs.com/)
39+
- every .js or .md file in `./pages` becomes a route that gets automatically processed and rendered!
4040

41-
This means you can write your app in `js` or `markdown` or even both! :smile:
41+
This means you can write your app in `js`, `markdown` or even both! :smile:
4242

4343
Your new nteract app will have the following strucure,
4444

@@ -80,3 +80,22 @@ Your new nteract app will have the following strucure,
8080
5. `yarn export`
8181

8282
This will export your code as a static HTML app.
83+
84+
## Contributing :tada:
85+
86+
Thanks for your interest in contributing! If you get stuck at any point, don't hesitate to reach out to the nteract team on slack or through the issue tracker.
87+
88+
To get started hacking on `create-nteract-app`, clone the repo and install dependencies.
89+
90+
```bash
91+
git clone https://github.com/nteract/create-nteract-app.git
92+
cd create-nteract-app
93+
yarn
94+
```
95+
96+
Now, make your changes and try them out with,
97+
`yarn dev your-test-app`
98+
99+
This will run `create-nteract-app` with any modifications you have made. Test your changes with `yarn test`.
100+
101+
See [CONTRIBUTING.md](https://github.com/nteract/create-nteract-app/blob/master/CONTRIBUTING.md) for more details.

0 commit comments

Comments
 (0)