Skip to content

Commit

Permalink
update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Carmine DiMascio committed Oct 23, 2019
1 parent c675005 commit cce9e33
Showing 1 changed file with 37 additions and 9 deletions.
46 changes: 37 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,50 @@
# contributing to express-openapi-vaidator
# Contributing

Contributors are welcome!

See something that needs fixing? Got an idea for a new feature? Contribute!

## Prerequisites / Setup

- Fork the repo
- Clone your copy `git clone <forked-repo>`
- `npm install`
1. Fork the repo

```shell
# The clone your copy
git clone <forked-repo>
```

2. Install the dependencies

```shell
# From the project directory, run
npm i
```

## Run the tests

```shell
npm test
```
3. Run the tests

```shell
npm test
```

## Develop

- Write code
- Add tests to validate new behaviors
- Ensure all tests succeed
- Create a PR
- Have fun!

## Project structure

`src` contains the source code
`test` contains the tests

## Need help
## Need help?

Reach out on [gitter](https://gitter.im/cdimascio-oss/community).

We're happy to help!

Reach out on [gitter](https://gitter.im/cdimascio-oss/community)
## Thanks!

0 comments on commit cce9e33

Please sign in to comment.