Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (66 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

106 lines (66 loc) · 2.59 KB
Raw

Contributing

Contributors are welcome!

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

Easy path to contribution

Click the Gitpod badge to set up a ready-to-code development environment in the cloud.

Gitpod Ready-to-Code

Standard path to contribution

Prerequisites / Setup

  1. Fork the repo

    # Then clone your copy
git clone <forked-repo>

  2. Install the dependencies

    # From the project directory, run
npm i

Continue to Create a Pull Request once you've written your code.

Run the tests

  1. Run the tests

    npm test

## Run tests against express@4 and express@latest
npm run test:all

## Run tests against express@4 only
## NOTE: remember to reinstall express@latest after the run (or run npm run test:express does it automatically)
npm run test:with-express4

## To continue testing express@4 after running the preceding command, you may now simply run npm test as npm run test:with-express4 installs express@4
npm test

  2. Update documentation

    Create a PR at - https://cdimascio.github.io/express-openapi-validator-documentation

Develop

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

Create a Pull Request

  1. Fork it

  2. Clone it to your local system

  3. Make a new branch

  4. Make your changes

  5. Push it back to your repo

  6. From the GitHub UI, click the Compare & pull request button.

    This button is available for a limited time after you push. If it is no longer available, open the pull request page and select the branches manually.

  7. Click Create pull request.

Project structure

src contains the source code test contains the tests

Need help?

Reach out on gitter.

We're happy to help!

FAQ

Q: I don't have permission to create a branch and I can't push my changes

A: You cannot directly create a branch in this repo. Instead Create a Pull Request

Misc

If you are not a project, you may ignore this section

Generate Change Log

Run the following each time a release is cut.

npm install -g conventional-changelog-cli
conventional-changelog -p express-openapi-validator -i CHANGE_HISTORY.md -s

Thanks!