Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Best practices: examples for plugin developers #21754

Closed
mahnunchik opened this issue Apr 21, 2020 · 3 comments
Closed

Best practices: examples for plugin developers #21754

mahnunchik opened this issue Apr 21, 2020 · 3 comments
Labels
[Type] Developer Documentation Documentation for developers

Comments

@mahnunchik
Copy link

mahnunchik commented Apr 21, 2020

Is your feature request related to a problem? Please describe.

We have good documentation for plugin developers https://developer.wordpress.org/block-editor/

But there are situations where it would be better to expect sample source code to understand feature and to understand best practices.

Even core maintainers don't understand some aspects of new editor: 10up/insert-special-characters#55

Describe the solution you'd like

It would be awesome to have some reference implementations. Simple but useful plugins to give developers ability to understand best practices.

For example I've used the Advanced Rich Text Tools for Gutenberg sources advanced-rich-text-tools from @ellatrix — a year ago it was awesome sample of good plugin.

But now it is too outdated and doesn't work at all https://wordpress.org/support/topic/wp-5-3-0-trying-to-get-property-base-of-non-object/ and ellatrix/advanced-rich-text-tools#8

I think it would be nice to have updated to latest API/capabilities reference simple plugin/plugins to show developers good examples.

Describe alternatives you've considered

Better handbook https://developer.wordpress.org/block-editor/ but sample plugin would be awesome too. The same for themes #21401

@annezazu annezazu added the [Type] Developer Documentation Documentation for developers label Apr 21, 2020
@oandregal
Copy link
Member

Hi @mahnunchik I don't see that you mentioned the https://github.com/wordpress/gutenberg-examples so I thought I'd share in case that's helpful and/or covers the need you suggested.

@mahnunchik
Copy link
Author

Hi @nosolosw Thanks, yep it is helpful. I forgot to mention it 😢

My idea is a little wider: to have sample plugin like Advanced Rich Text Tools for Gutenberg to receive feedback not only from developers but from usual users too.

@ryanwelcher
Copy link
Contributor

The Gutenberg Examples repository is meant to serve this purpose so I am going to close this out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

4 participants