Thank you for contributing. Contributions are always welcome, no matter how large or small.
As a contributor, here are the guidelines we would like you to follow:
- Code of conduct
- How can I contribute?
- Using the issue tracker
- Submitting a Pull Request
- Coding rules
- Working with code
We also recommend to read How to Contribute to Open Source.
Thank you for contributing.
- Create your branch from
master. - Ensure your git commit messages follow the required format.
- Ensure your scripts are well-formed, well-documented and object-oriented.
- Ensure your scripts are stateless and can be reused by all.
- Update your branch, and resolve any conflicts, before making pull request.
- Fill in the required template.
- Do not include issue numbers in the PR title.
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the style guide applicable to the language or task.
- Include thoughtfully-worded, well-structured tests/specs. See the Tests/Specs Style Guide.
- Document new code based on the Documentation Style Guide.
- End all files with a newline.
git clone https://github.com/tandfgroup/schema-oas.git schema-oas && cd schema-oas# Using NPM:
npm installschema-oas/
├─ spec/ * directory containing all OpenAPI spec files
│ ├─ endpoints/ * directory containing endpoint-based specs
│ │ ├─ <endpoint>/ * <endpoint> directory
│ │ : ├─ paths.yml * <endpoint> path specs
│ │ :
│ │
│ ├─ schema/ * directory containing schema objects
│ │ ├─ <schema>.yml * <schema> object
│ │ :
│ │
│ ├─ api.yml * OpenAPI Specification
│ ├─ components.yml * OpenAPI Components object
│ ├─ info.yml * OpenAPI Info object
│ ├─ paths.yml * Paths - auto-generated compile of all path specs
│ └─ schema.yml * Schema - auto-generated compile of all schema objects
│
├─ tests/ * files related to testing
│ ├─ filename.ext * TBD
│ :
│
├─ commitlint.config.js * commitlint config
├─ package-lock.json * npm dependency lock file
└─ package.json * npm package config