Update README, add CONTRIBUTING #431
Merged
Conversation
This file contains 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
Per discussion in WordPress slack office hours this past Wednesday, this PR seeks to clarify the developer contribution workflow by adding a new separate contribution document. In this I expanded on how to name branches, and branch off master. Context: https://wordpress.slack.com/archives/C02QB2JS7/p1492017131774539
aduth
reviewed
Apr 17, 2017
|
|
||
| If you'd like to try or contribute to the plugin, you can clone this repo into your `wp-content/plugins` directory, then activate the plugin. You'll get a separate WordPress menu item called Gutenberg. | ||
|
|
||
| Be sure to have <a href="https://nodejs.org/en/">Node installed first</a>. Then, in a terminal, type `npm install` to get the dependencies all set up. Once that finishes, you can type `npm run build` to make the plugin functional, or `npm run dev` to keep the plugin building in the background as you work on it. |
There was a problem hiding this comment.
Depending on how much depth we want to go into here, I see this step being the main road bump along the way to getting started. We could add a little more detail about navigating to the plugin directory in the terminal. We could reference that the equivalent to terminal in Windows is the Command Prompt. We might even want to go into some detail (or link to references) about how to set up a local WordPress environment, or directories to find a local install for popular tools (default OSX Apache folder, MAMP, Desktop Server).
There was a problem hiding this comment.
I will make a personal ToDo note to expand this section one of these days. Running out of steam for today :)
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.
Per discussion in WordPress slack office hours this past Wednesday, this PR seeks to clarify the developer contribution workflow by adding a new separate contribution document. In this I expanded on how to name branches, and branch off master.
Context: https://wordpress.slack.com/archives/C02QB2JS7/p1492017131774539