diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d049060c..55c1729c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,8 +32,8 @@ It is not required but highly suggested that you create unit tests for the code ### Tips - Smaller changes are easier to review -- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix +- [Optional] For bug fixes, provide an OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix - Add test case(s) to cover the change - Make sure test cases passed after the change. All tests run after a PR is created or modified. -- File a PR with meaningful title, description and commit messages. +- File a PR with a meaningful title, description and commit messages. - To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/)) diff --git a/README.md b/README.md index e3c3b4ef..5c7194d8 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ The options file is described in json (example in `specs/options.json`), and has |schemaNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`PascalCase`|Naming convention for schemas| |propertyNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`CamelCase`|Naming convention for properties| |enumNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`AnyCase`|Naming convention for enums| -|allowedModelProperties|array| `["_links", "_embedded"]`|`[]`|An array of property names that are authorised even if they do not match to the "propertyNamingConvention"| +|allowedModelProperties|array| `["_links", "_embedded"]`|`[]`|An array of property names that are authorized even if they do not match to the "propertyNamingConvention"| #### Parameter Naming Convention hierarchy diff --git a/cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java b/cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java index fe226e8c..1c357d5b 100644 --- a/cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java +++ b/cli/src/main/java/org/openapitools/openapistylevalidator/cli/OutputUtils.java @@ -28,7 +28,7 @@ void printHelp(final Options options, final String cmdLineSyntax) { options, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, - "Thanks for using OpenAPI Style Validator! If you this project useful, consider buying us a tree here: https://ecologi.com/darkjaff", + "Thanks for using OpenAPI Style Validator! If you find this project useful, consider buying us a tree here: https://ecologi.com/darkjaff", true); printWriter.flush(); diff --git a/docs/contributing.md b/docs/contributing.md index e1d0140a..70c5c1d9 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -36,8 +36,8 @@ It is not required but highly suggested that you create unit tests for the code ### Tips - Smaller changes are easier to review -- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix +- [Optional] For bug fixes, provide an OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix - Add test case(s) to cover the change - Make sure test cases passed after the change. All tests run after a PR is created or modified. -- File a PR with meaningful title, description and commit messages. +- File a PR with a meaningful title, description and commit messages. - To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/)) \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 302d58a7..b3cd1b08 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -5,7 +5,7 @@ title: "FAQ: General" ## Do you have a chat room? -[![Jion the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM) +[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM) ## What is the governance structure of the OpenAPI Style Validator project? diff --git a/gradle-plugin/src/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java b/gradle-plugin/src/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java index ac968810..6ea3c2d3 100644 --- a/gradle-plugin/src/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java +++ b/gradle-plugin/src/main/java/org/openapitools/openapistylevalidator/gradle/OpenAPIStyleValidatorTask.java @@ -47,7 +47,7 @@ public class OpenAPIStyleValidatorTask extends DefaultTask { public OpenAPIStyleValidatorTask() { this.setGroup("Verification"); - this.setDescription("Validate that OpenAPI files against style rules"); + this.setDescription("Validate OpenAPI files against style rules"); } @TaskAction diff --git a/website/src/pages/team.js b/website/src/pages/team.js index d7de1fc6..4813ec11 100644 --- a/website/src/pages/team.js +++ b/website/src/pages/team.js @@ -4,7 +4,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import styles from './styles.module.css'; -// This is based mostly off of Babel's website configuration for Members/orgs/etc. +// This is based mostly on Babel's website configuration for Members/orgs/etc. function MediaLink(props) { if (props.text) { return ( diff --git a/website/src/pages/users.js b/website/src/pages/users.js index 334933e3..eabc4d04 100644 --- a/website/src/pages/users.js +++ b/website/src/pages/users.js @@ -13,7 +13,7 @@ function Users() { const {users = {}} = siteConfig.customFields; let showcase = users.map((user, idx) => { - // avoid joining base/ with /img/path as double-slash breaks image load. + // Avoid joining base/ with /img/path as a double-slash breaks image load. let trimmedImg = user.image.startsWith("/") ? user.image.slice(1, user.image.length) : user.image; let imgUrl = useBaseUrl(trimmedImg); return (