@backmarket-api/rulesets
v1.7.0
Published
Backmarket API spectral ruleset
Readme
api-rulesets
The workflow might change in the future as Stoplight have now advanced style guides features.
How to use
- cd to your project
touch .spectral.yaml- Add this content
extends:
- https://unpkg.com/@backmarket-api/[email protected]How to collaborate
We are using semantic-release.
You are adding a spectral rule that is not a breaking change
Example of breaking changes
- You are increasing severity level from (
warn|info|hint) toerror - You are changing processing rules of custom functions that increase linting errors
- Any change that increase linting errors
- Make you changes in a
fix/[any-name](eg:fix/add-kebab-cases-exceptions) - Commit message must have the following format
* fix: Add buyback kebab-case paths exceptions- Push you changes to your branch
- Ask a review
- Merge into the main branch
If you are breaking changes
- Make you changes in a
feat/[any-name](eg:feat/enforce-camel-case) - Commit message must have the following format
* feat: Enforce camel case in properties- Push you changes to your branch
- Ask a review
- Merge into the main branch
- Communicate in the API Chapter the change so people can update thier ruleset versions
