Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 2.07 KB
Raw

Contributing to express-jsdoc-swagger

Thanks for your interest in express-jsdoc-swagger. Our goal is to provide an easy Swagger OpenAPI 3.x generator using simple JSDoc comments.

Contributions

express-jsdoc-swagger welcomes contributions from everyone.

Contributions to express-jsdoc-swagger should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (@bri06 or @kevinccbsg) and either landed in the main tree or given feedback for changes that would be required.

Getting Started

express-jsdoc-swagger's open issues are here.

express-jsdoc-swagger's docs are here.

You can clone this repository and run this command to start using developing this package.

npm install

If you want to test it you can add a new test in this folder or you can create a new example here.

To execute package's tests you have run this command:

npm test

Please also ensure linting is correct while you're developing by running this command:

npm run lint

Pull Request Checklist

  • Check validations should pass. This one includes linting and testing.

  • Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.

Conduct

We follow the express-jsdoc-swagger Code of Conduct.

All code in this repository is under MIT License.