-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
[docs] link to plugin README template in Creating a Plugin guide #14774
Comments
I would like to take this one! |
I have a change ready to go out for PR, but need repo access. Is that something I have to request somewhere other than here? |
Thanks @k-conway! It looks like you forked the repository (which basically created your own version of Gatsby on your GitHub profile), sounds like you'll need to do a couple things if you haven't already:
Let me know if you need any help! |
Hey @k-conway have you been able to get to this, or need any help? 🙂 |
hi! I will be back at this today! sorry for the delay!
…On Mon, Jun 17, 2019 at 9:11 AM gillkyle ***@***.***> wrote:
Hey @k-conway <https://github.com/k-conway> have you been able to get to
this? 🙂
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#14774?email_source=notifications&email_token=AHLLZXC6CX7ERHOC4O4JGOTP26LRBA5CNFSM4HX3DVOKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODX3JHRA#issuecomment-502698948>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AHLLZXBGWPCGWAOZICHROKTP26LRBANCNFSM4HX3DVOA>
.
|
@k-conway no worries, feel free to get to it when you have time, just want to make sure you don't get stuck and/or frustrated 👍 |
Thank you so much for reaching out! I just sent in my Pull Request!
…On Mon, Jun 17, 2019 at 11:16 AM gillkyle ***@***.***> wrote:
@k-conway <https://github.com/k-conway> no worries, feel free to get to
it when you have time, just want to make sure you don't get stuck and/or
frustrated 👍
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#14774?email_source=notifications&email_token=AHLLZXDEFW5FYXYRXSZOZZTP262GXA5CNFSM4HX3DVOKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODX3WAIQ#issuecomment-502751266>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AHLLZXG6NJWRL4K2SCN5XOTP262GXANCNFSM4HX3DVOA>
.
|
Summary
An important hurdle users trying to leverage plugins encounter is not enough documentation, or difficult to understand documentation on plugins. In the Creating Plugins guide there currently isn't much information (only a few sentences at the end of the Submit to Plugin Library section) guiding a plugin author on what should be included in their README.
There is already a template for plugin READMEs thanks to #4284 that exists but it is not linked to or mentioned in that guide.
What to Do
Some helpful things that could be added:
The text was updated successfully, but these errors were encountered: