-
Notifications
You must be signed in to change notification settings - Fork 299
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] - plugin checklist approval blockers #709
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. I'm happy to merge it now if you want? Or you can wait for David to take a peek first. Your choice? We can always land this and then create a new issue if there is more to add.
⚡️ Lighthouse report for the deploy preview of this PR
|
Ah - linting check is failing. This is something you can fix automatically:
Essentially this is complaining because you're referencing another document in the same section (general vs. docs). Where we do that we use a relative link to the markdown file because it allows better link checking. |
Many thanks @danmarsden for this. My only comment would be that the "Compliance with security guidelines" does not fit well into the "[something] that will prevent your plugin from being approved". The intention here was to list the approval blockers. So the blocker here could be something like "Violation of security guidelines" or so, no? |
I've amended the branch and force-pushed it. Note: Probably best not to branch it to |
adds some common approval blockers to the checklist - in particular the security guidelines and significant namespace collisions are typical blockers.
@mudrd8mz good to have a +1 from you (or a -1) :-)
first dev docs PR so let me know if I've got something wrong...