Skip to content

Commit

Permalink
#35 Updates CONTRIBUTING.md to help developers lo launch the project …
Browse files Browse the repository at this point in the history
…in local machines
  • Loading branch information
jabalde committed Jun 21, 2022
1 parent ca106a5 commit e0cd8dc
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<p align="center">
<a href="#best-practices">Best practices</a> ·
<a href="#quickstart">Quickstart</a> ·
<a href="#pull-request-process">Pull request process</a> ·
<a href="#code-of-conduct">Code of conduct</a>
</p>
Expand Down Expand Up @@ -29,6 +30,48 @@ project. We encourage you to follow them and help us create a better product!
- Create commit messages that briefly describe the change applied, preferably in
English.

## Quickstart

### Dependencies

To install dependencies, after cloning the repository, run:

```bash
npm install
```

### Clean
To clean output & build path run:

```bash
npm run clean
```

### Build

To build the application, run:

```bash
npm run build
```


### Usage
To execute the application run:

```bash
npm start -- -i input/file.yaml
```

You can find all the options in our [README](./README.md) file

### Putting all together
When you are developing a new feature you must clean output & build path, rebuild the app and execute it. So this is a good command to _remember_:

```bash
npm run clean && npm run build && npm start -- -i input/file.yaml
```

## Pull request process

1. Ensure any install or build dependencies are solved before doing a build.
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<p align="center">
<a href="#-summary">Summary</a> ·
<a href="#-getting-started">Getting started</a> ·
<a href="#-contributing">Contributing</a> ·
<a href="#-support">Support</a> ·
<a href="#license">License</a>
</p>
Expand Down Expand Up @@ -55,13 +56,17 @@ Options:
-h, --help shows this help
```

## 🤝 Contributing

If you want to collaborate with the project, please read our [CONTRIBUTING.md](./CONTRIBUTING.md) where you can find our guidelines

## 🧰 Support

We’ll be glad to talk and discuss how `openapi-nodejs-cli` can help you 😊

Reach us through [GitHub issues](https://github.com/corunet/openapi-nodejs-cli/issues), [email](mailto:[email protected]) or [Twitter](https://twitter.com/corunet).

## License
## 🔐 License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at [https://mozilla.org/MPL/2.0/](https://mozilla.org/MPL/2.0/).
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://github.com/corunet/openapi-nodejs-cli/blob/main/LICENSE)

0 comments on commit e0cd8dc

Please sign in to comment.