api-rulesets

The workflow might change in the future as Stoplight have now advanced style guides features.

How to use

1. cd to your project
2. touch .spectral.yaml
3. 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) to error
• You are changing processing rules of custom functions that increase linting errors
• Any change that increase linting errors

1. Make you changes in a fix/[any-name] (eg: fix/add-kebab-cases-exceptions)
2. Commit message must have the following format

* fix: Add buyback kebab-case paths exceptions

3. Push you changes to your branch
4. Ask a review
5. Merge into the main branch

If you are breaking changes

1. Make you changes in a feat/[any-name] (eg: feat/enforce-camel-case)
2. Commit message must have the following format

* feat: Enforce camel case in properties

3. Push you changes to your branch
4. Ask a review
5. Merge into the main branch
6. Communicate in the API Chapter the change so people can update thier ruleset versions