Skip to content

Commit dd170cc

Browse files
authored
Merge pull request #431 from WordPress/add/readme-contrib-instructions
Update README, add CONTRIBUTING
2 parents 76e3155 + ef2aef8 commit dd170cc

File tree

2 files changed

+25
-8
lines changed

2 files changed

+25
-8
lines changed

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
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.
4+
5+
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.
6+
7+
## Workflow
8+
9+
A good workflow is to work directly in this repo, branch off `master`, and submit your changes as a pull request.
10+
11+
Ideally name your branches with prefixes and descriptions, like this: `[type]/[change]`. A good prefix would be:
12+
13+
- `add/` = add a new feature
14+
- `try/` = experimental feature, "tentatively add"
15+
- `update/` = update an existing feature
16+
17+
For example, `add/gallery-block` means you're working on adding a new gallery block.
18+
19+
You can pick among all the <a href="https://github.com/WordPress/gutenberg/issues">tickets</a>, or some of the ones labelled <a href="https://github.com/WordPress/gutenberg/labels/Good%20First%20Task">Good First Task</a>.
20+
21+
## How Designers Can Contribute
22+
23+
If you'd like to contribute to the design or front-end, feel free to contribute to tickets labelled <a href="https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+label%3ADesign">Design</a>. We could use your thoughtful replies, mockups, animatics, sketches, doodles. Proposed changes are best done as minimal and specific iterations on the work that precedes it so we can compare. If you use <a href="https://www.sketchapp.com/">Sketch</a>, you can grab <a href="https://cloudup.com/cMPXM8Va2cy">the source file for the mockups</a> (updated April 6th).

README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,9 @@ In the end you should be able to start up a new post, _type type type_ then _cli
2020
- <a href="https://wordpress.github.io/gutenberg/">Prototypes</a>.
2121
- <a href="https://github.com/Automattic/wp-post-grammar">WP Post grammar parser</a>.
2222

23-
## How Developers Can Contribute
23+
## How You Can Contribute
2424

25-
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.
26-
27-
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. You can pick among all the <a href="https://github.com/WordPress/gutenberg/issues">tickets</a>, or some of the ones labelled <a href="https://github.com/WordPress/gutenberg/labels/Good%20First%20Task">Good First Task</a>.
28-
29-
## How Designers Can Contribute
30-
31-
If you'd like to contribute to the design or front-end, feel free to contribute to tickets labelled <a href="https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+label%3ADesign">Design</a>. We could use your thoughtful replies, mockups, animatics, sketches, doodles. Proposed changes are best done as minimal and specific iterations on the work that precedes it so we can compare. If you use <a href="https://www.sketchapp.com/">Sketch</a>, you can grab <a href="https://cloudup.com/cMPXM8Va2cy">the source file for the mockups</a> (updated April 6th).
25+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
3226

3327
## Why
3428

0 commit comments

Comments
 (0)