Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 2.05 KB

Contributing Guidelines

How to contribute

Contributions from the community are welcome. Please follow this guide when logging issues or helping maintain the code.

Logging Issues

All issues should be created using the new issue form.

  • Please check the "Features from Hapi that cannot be ported to Swagger" section of the usage guide.
  • Try the plugin option debug = true to see if any errors or warning are logged. see Debugging
  • Clearly describe the issue including steps to reproduce it. Also include example code of any routes that cause an issue.

Fixes and patches

Code changes are welcome and should follow the guidelines below. If you wish to add a new feature or make a major change it is worth raising an issue first.

  • Fork the repository on GitHub.
  • Fix the issue ensuring that your code follows the style guide.
  • Add tests for your new code ensuring that you have 100% code coverage (we can help you reach 100% but will not merge without it).
    • Run npm test to generate a report of test coverage
  • Pull requests should be made to the master branch.

Testing

The project has integration and unit tests. To run the test within the project type one of the following commands. or

npm test

or

lab
lab -r html -o coverage.html
lab -r html -o coverage.html --lint
lab -r console -o stdout -r html -o coverage.html --lint

Publishing

To publish, just run:

npm version $VERSION_NUMBER

Where $VERSION_NUMBER is appropriate semver version for the current release. The npm version command will trigger:

  • npm test
  • npm publish
  • git push to origin