Contributing updates #173
Merged
Contributing updates #173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cholmes
previously approved these changes
Jul 23, 2021
CONTRIBUTING.md
Outdated
| To install you'll need npm, which is a standard part of any [node.js installation](https://nodejs.org/en/download/). | ||
| Alternatively, you can also use [yarn](https://yarnpkg.com/) instead of npm. In this case replace all occurrences of | ||
| `npm` with `yarn` below. | ||
| The same check-markdown and check-examples programs that runs as a check on PR's is part of the repo and can be run locally. |
There was a problem hiding this comment.
I don't think 'check-examples' is part of the api spec repo? Running 'check' seems to use check-markdown and check-openapi. Should update this to explain what check-openapi does. Running it right now seems to raise some warnings, so we should probably try to fix those:
/Users/cholmes/Repos/stac-api-spec/fragments/filter/cql.yml
16:9 warning oas3-parameter-description Parameter objects should have a `description`. components.schemas.booleanValueExpression.oneOf[3]
/Users/cholmes/Repos/stac-api-spec/fragments/filter/openapi.yaml
10:9 warning operation-description Operation `description` must be present and non-empty string. paths./.get
10:9 warning operation-tags Operation should have non-empty `tags` array. paths./.get
29:11 warning operation-tag-defined Operation tags should be defined in global tags. paths./queryables.get.tags[0]
42:9 warning operation-description Operation `description` must be present and non-empty string. paths./collections/{collectionId}.get
42:9 warning operation-tags Operation should have non-empty `tags` array. paths./collections/{collectionId}.get
74:11 warning operation-tag-defined Operation tags should be defined in global tags. paths./collections/{collectionId}/queryables.get.tags[0]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue(s): #151
Proposed Changes:
PR Checklist:
stac-specdirectory (these are included as a subtree and should be updated directly in radiantearth/stac-spec)