Skip to content

Commit

Permalink
updating contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
jbend committed Jul 13, 2023
1 parent f9aefb5 commit 3ea3fd0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to the Trimble OpenAPI Style Guide
# Contributing to the Trimble OpenAPI Spectral Rules

If you would like to contribute to this project please read the [contributing guidelines](https://trimble-oss.github.io/contribute/guidelines/).

Expand Down Expand Up @@ -34,7 +34,7 @@ When creating new rules we have some conventions that should be followed. For ru
| ------- | ---------------------------------------------------------------------------------- |
| name | prefixes: |
| | "`tdp-`" Trimble Developer Program |
| | "`tas-`" Trimble API Standards |
| | "`tas-`/`tapi`" Trimble API Standards |
| formats | You can add formats, however, tdp has a warning rule on oas formats lower than 3.0 |

Rule name convention, not really strict about this, but it should be something like:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Trimble OpenAPI Spectral rules

This repository contains Spectral rules for linting Trimble OpenAPI specification documents. These rules are a companion to the Trimble Web API Standards.
This repository contains Spectral rules for linting Trimble OpenAPI specification documents. These rules are a companion to the Trimble Web API Standard.

## How to use the Spectral ruleset

Expand Down

0 comments on commit 3ea3fd0

Please sign in to comment.