Skip to content

Conversation

@JustinyAhin
Copy link
Member

This PR adds the documentation to get start with contribution to the performance plugin. It also adds the new documentation page to the /docs/README.md file.

See https://github.com/WordPress/performance/blob/add/39-contributing-documentation/docs/Getting-started.md for the new doc.

Fixes #39.

Create the documentation to get start with contribution to the plugin
@JustinyAhin JustinyAhin added the [Type] Documentation Documentation to be added or enhanced label Dec 13, 2021
@JustinyAhin JustinyAhin added this to the Initial plugin release milestone Dec 13, 2021
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JustinyAhin This looks great, I've added a few comments with minor suggestions, mostly around possible ways to improve the reading flow.

One more thing: Can you also add a CONTRIBUTING.md file in this PR? That is the standard place for people to look, so we should have this file and was also mentioned in the issue #39. The file can be super minimal and mostly just link to the other documentation file that you're adding here. Maybe take Gutenberg's one for inspiration, although I think ours could even be simpler than that.

Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@felixarntz felixarntz merged commit f5be653 into trunk Dec 15, 2021
@felixarntz felixarntz added the Infrastructure Issues for the overall performance plugin infrastructure label Dec 15, 2021
@JustinyAhin JustinyAhin deleted the add/39-contributing-documentation branch December 16, 2021 07:13
@JustinyAhin JustinyAhin restored the add/39-contributing-documentation branch December 16, 2021 07:13
@tillkruss tillkruss deleted the add/39-contributing-documentation branch March 7, 2022 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Infrastructure Issues for the overall performance plugin infrastructure [Type] Documentation Documentation to be added or enhanced

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs on contributing to the performance plugin

3 participants