|
1 |
| -# WPGraphQL Coding Standards for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) |
| 1 | +# WPGraphQL Coding Standards for PHP_CodeSniffer |
2 | 2 |
|
3 |
| -This project is a collection of rules and sniffs for PHPCS to validate code developed for the [WPGraphQL](https://github.com/wp-graphql/wp-graphql) ecosystem. It uses rules from: |
| 3 | +      |
| 4 | + |
| 5 | +----- |
| 6 | +This project is a collection of rules and sniffs for [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) to validate code developed for the [WPGraphQL](https://github.com/wp-graphql/wp-graphql) ecosystem. It uses rules from: |
4 | 7 | - [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards)
|
5 | 8 | - [Automattic VIP Coding Standards](https://github.com/Automattic/VIP-Coding-Standards)
|
6 | 9 | - [Slevomat Coding Standard](https://https://github.com/slevomat/coding-standard)
|
@@ -55,3 +58,13 @@ In this file, you will want to configure the following:
|
55 | 58 | - [`minimum_wp_version`](./phpcs.xml.dist.example#L43) - The minimum WordPress version you want to test against. This should be the lowest version of WordPress that you want to support. While WPGraphQL officially supports WordPress 5.0+, we recommend testing against WordPress 5.6 (the current lowest version actively [tested against](https://github.com/wp-graphql/wp-graphql/blob/develop/.github/workflows/testing-integration.yml)) or higher.
|
56 | 59 | - [`WordPress.WP.I18n.text_domain`](./phpcs.xml.dist.example#L63) - The text domain used in your project. This is used by the `WordPress.WP.I18n` sniff to check that all translatable strings are assigned to a text domain. We recommend using the format `wp-graphql-<project-name>`.
|
57 | 60 | - [`WordPress.NamingConventions.PrefixAllGlobals`](./phpcs.xml.dist.example#L57) - The list of prefixes used in your project. This is used by the `WordPress.NamingConventions.PrefixAllGlobals` sniff to check that all global functions, classes, constants, and variables are prefixed.
|
| 61 | + |
| 62 | +## Development and Support |
| 63 | + |
| 64 | +The project is actively maintained by [AxePress Development](https://axepress.dev). Community contributions are _welcome_ and **encouraged**. |
| 65 | + |
| 66 | +Basic support is provided for free, both in [this repo](https://github.com/AxeWP/WPGraphQL-Coding-Standards/issues) and in [WPGraphQL's official Discord](https://discord.gg/55h7WmYZff). |
| 67 | + |
| 68 | +Priority support and custom development are available to [our Sponsors](https://github.com/sponsors/AxeWP). |
| 69 | + |
| 70 | +<a href="https://github.com/sponsors/AxeWP" alt="GitHub Sponsors"><img src="https://img.shields.io/static/v1?label=Sponsor%20Us%20%40%20AxeWP&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86&style=for-the-badge" /></a> |
0 commit comments