An open API service indexing awesome lists of open source software.

https://github.com/wp-graphql/wpgraphql-ide

A next-gen query editor for WPGraphQL 🚀
https://github.com/wp-graphql/wpgraphql-ide

graphql wordpress wordpress-plugin

Last synced: 1 day ago
JSON representation

A next-gen query editor for WPGraphQL 🚀

Awesome Lists containing this project

README

        

# WPGraphQL IDE

> A next-gen query editor for [WPGraphQL](https://github.com/wp-graphql/wp-graphql) 🚀

https://github.com/josephfusco/wpgraphql-ide/assets/6676674/88e128f0-a682-42ec-84d8-ff8474d7e683

## Install

See [releases](https://github.com/josephfusco/wpgraphql-ide/releases) to download, or [download from packagist.org](https://packagist.org/packages/josephfusco/wpgraphql-ide) via composer.

## Usage

When this plugin is active, a new settings tab "IDE Settings" will appear in the WPGraphQL settings screen.

![WPGraphQL IDE Settings tab showing the admin bar link behavior and Show legacy editor settings](https://github.com/wp-graphql/wpgraphql-ide/assets/6676674/59236b4c-0019-40a8-ae9b-a1228997f30c)

## Breaking Changes Policy

We are committed to maintaining a stable and reliable interface for users of our WordPress plugin. To ensure a seamless experience, we adhere to the following policy regarding breaking changes:

### Policy Statement

1. **Access Functions**: We will not introduce any intentional breaking changes to access functions specifically created to interface with the plugin. These functions are the primary means for interacting with our plugin and will remain consistent across updates.

2. **Public Redux Stores**: We commit to maintaining the public Redux stores using `@wordpress/data` without any breaking changes. This ensures your integrations with our plugin's state management remain stable and predictable.

3. **Internal Refactoring**: Refactoring internal functions and variables not related to the above does not constitute a breaking change. These modifications aim to enhance the plugin's internal structure and performance without impacting the intentionally public API.

4. **Semantic Versioning**: If a breaking change is necessary, we will adhere to [Semantic Versioning](https://semver.org/) (SemVer). This means any breaking changes will result in an increment of the major version number, clearly signaling the change.

### Access Functions Documentation

Please use the designated access functions to interface with our plugin. These functions are designed to provide stable interaction points and are detailed in [ACCESS_FUNCTIONS.md](ACCESS_FUNCTIONS.md).

By following this policy, we aim to build trust and reliability, ensuring that your integrations remain functional and stable with each new release.

### Custom Hooks Documentation

See [ACTIONS_AND_FILTERS.md](ACTIONS_AND_FILTERS.md).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)