FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add contribution documentation by JustinyAhin · Pull Request #47 · WordPress/performance · GitHub

/ performance Public

Add contribution documentation - #47

Merged
felixarntz merged 9 commits into
trunkfrom
add/39-contributing-documentation
Dec 15, 2021
ConversationCommits (9)ChecksFiles changed
Merged

Add contribution documentation#47
felixarntz merged 9 commits into
trunkfrom
add/39-contributing-documentation

Conversation

JustinyAhin commented Dec 13, 2021

Copy link
Copy Markdown
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 Getting-started.md
b146c4d 
Create the documentation to get start with contribution to the plugin
Add the new doc page to the summary
10d7830
JustinyAhin added the [Type] Documentation Documentation to be added or enhanced label Dec 13, 2021
JustinyAhin added this to the Initial plugin release milestone Dec 13, 2021
felixarntz reviewed Dec 13, 2021
View reviewed changes

felixarntz left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@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.

Comment thread docs/README.md Outdated
Comment thread docs/Getting-started.md Outdated
Comment thread docs/Getting-started.md Outdated
Comment thread docs/Getting-started.md Outdated
Comment thread docs/Getting-started.md Outdated
Comment thread docs/Getting-started.md Outdated
Comment thread docs/Getting-started.md Outdated
This was referenced Dec 14, 2021
Closed
Closed
felixarntz approved these changes Dec 15, 2021
View reviewed changes

felixarntz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

🎉

felixarntz merged commit f5be653 into trunk Dec 15, 2021
felixarntz added the Infrastructure Issues for the overall performance plugin infrastructure label Dec 15, 2021
JustinyAhin deleted the add/39-contributing-documentation branch December 16, 2021 07:13
JustinyAhin restored the add/39-contributing-documentation branch December 16, 2021 07:13
tillkruss deleted the add/39-contributing-documentation branch March 7, 2022 19:28
gerardv mentioned this pull request Feb 18, 2023
Closed
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

felixarntz felixarntz approved these changes
adamsilverstein Awaiting requested review from adamsilverstein
aristath Awaiting requested review from aristath
ThierryA Awaiting requested review from ThierryA

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

1.0.0-beta.1

Development

Successfully merging this pull request may close these issues.

Add docs on contributing to the performance plugin

2 participants

Back | FazBrowse Home | New Git URL