Add contribution documentation #47
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Create the documentation to get start with contribution to the plugin
felixarntz
reviewed
Dec 13, 2021
There was a problem hiding this comment.
@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.
This was referenced Dec 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.mdfile.See https://github.com/WordPress/performance/blob/add/39-contributing-documentation/docs/Getting-started.md for the new doc.
Fixes #39.