Add contributing information to packages #38122
Conversation
talldan
requested review from
annezazu,
a team,
gziolo,
nerrad,
kevin940726,
getdave,
noisysocks,
tellthemachines,
adamziel,
anton-vlasenko and
draganescu
and removed request for
a team
|
Thank you for starting this! Maybe we should also include this in the general guideline when creating a new package as well. |
|
Great idea. I guess we need only to agree on the wording and apply it to all existing packages. ❤️ |
|
LGTM. That's a good improvement! |
|
I've changed the wording a bit. Let me know what you think. |
|
It looks great ❤️ |
packages/README.md
Outdated
| @@ -46,6 +46,7 @@ When creating a new package, you need to provide at least the following: | |||
| - Installation details | |||
| - Usage example | |||
| - API documentation, if applicable ([more info](#maintaining-api-documentation)) | |||
| - A link to the contributing guidelines | |||
There was a problem hiding this comment.
Should we put the full text of the new section proposed so people can copy and paste it?
There was a problem hiding this comment.
Maybe something like a script to auto-generate a new package would be better? Not something should be covered in this PR though but just an idea 🙈 .
There was a problem hiding this comment.
I've added a link to the text in one of the packages. 👍
There was a problem hiding this comment.
I completely agree with these type of improvements. I think there's a lot still to do in terms of adding context to the different lines of resources generated from the WordPress Core ecosystem. I find this specific change SUPER useful and I'd love to see more like this one.
Thank you @talldan for taking care of this.
talldan
force-pushed
the
add/contributor-guide-links-to-packages
branch
from
97829dc to
42cb8bf
Compare
talldan
requested review from
adamsilverstein,
ajitbohra,
atimmer,
cameronvoell,
dmsnell,
ellatrix,
mkaz,
mmtr,
noahtallen,
ntwb,
oandregal and
swissspidy
as code owners
|
Thanks for the reviews everyone. I've added copy/pasted the text across to all packages now and will merge when CI passes 👍 |
Description
One of the valid ways to find out about an individual Gutenberg package is via npm (https://www.npmjs.com/package/@wordpress/components). From there users can visit a package homepage (which most prominently shows the package's README file) to find out more about a package (https://github.com/WordPress/gutenberg/blob/trunk/packages/components/README.md). Some visitors may wish to make a contribution, but our package READMEs don't contain links to the contributor guide.
It'd be nice to rectify that to improve the contribution experience.
Here I've started off by adding details to one package (a11y, because its first in the alphabetical list). I'm looking for feedback on the text. Once that's honed, I'll copy and paste it across to the other packages.
Types of changes
Documentation