website-v2 icon indicating copy to clipboard operation
website-v2 copied to clipboard

Add quality guidelines page

Open lisa-wolfgang opened this issue 3 years ago • 10 comments
trafficstars

This PR adds quality guidelines for PRs to the main extension repo.

Since the addon compatibility checklist will be a large undertaking, it will be PRed separately.

lisa-wolfgang avatar Jul 18 '22 23:07 lisa-wolfgang

I think creating-an-addon.md needs to be re-done, but I'm not sure if that should go in this PR.

Samq64 avatar Jul 19 '22 01:07 Samq64

This PR should be for new docs content related to the overhauled PR merge system in ScratchAddons/ScratchAddons.

lisa-wolfgang avatar Jul 19 '22 01:07 lisa-wolfgang

The addon compatibility list will be a relatively large undertaking. Contributions from those experienced in specific areas of the website and editor would be greatly appreciated. See https://github.com/ScratchAddons/website-v2/pull/225

lisa-wolfgang avatar Jul 19 '22 22:07 lisa-wolfgang

It might be a good idea to require approvals to be accompanied by a checklist (as a comment on the approval) that we provide on this page. That way, the person approving the PR communicates exactly what they've looked at.

lisa-wolfgang avatar Aug 02 '22 20:08 lisa-wolfgang

There hasn't been any additional feedback on these guidelines for a while, so I'm going to assume that they're final for the time being. However, to have any actual bearing on the PR approval process, org members will need to become familiar (and agree) with these guidelines.

@WorldLanguages @apple502j @GarboMuffin @GrahamSH-LLK @Hans5958 @jeffalo @mxmou @RedGuy12 @TheColaber @Weredime Please either mark your approval of these guidelines (by approving the PR) or leave a review requesting changes.

lisa-wolfgang avatar Oct 02 '22 21:10 lisa-wolfgang

It may be a good idea to ask contributors to join the Discord server or at least create an issue for discussion about PRs before creating them -- often times people try to make rejected or very complex addons as their first PR.

cobaltt7 avatar Oct 03 '22 14:10 cobaltt7

It may be a good idea to ask contributors to join the Discord server or at least create an issue for discussion about PRs before creating them -- often times people try to make rejected or very complex addons as their first PR.

I'd rather have a focus to create an issue compared to joining the Discord server.

Hans5958 avatar Oct 07 '22 17:10 Hans5958

We should try to get this merged sometime soon, even if it's not 100% perfect. We can always tweak it later.

WorldLanguages avatar Dec 26 '22 22:12 WorldLanguages

Bump to have fresh ideas

Hans5958 avatar May 01 '23 07:05 Hans5958

https://scratchaddons.com/docs/develop/userscripts/best-practices/ exists now and there will probably be a similar page for userstyles in the future, so we should probably link those.

Samq64 avatar May 01 '23 13:05 Samq64