Skip to content

Commit d2f9f8d

Browse files
committed
Document including static assets with Pull Requests
1 parent fabe4d2 commit d2f9f8d

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

CONTRIBUTING.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,33 @@ Not sure how? Check out the [Blueprints 101](./docs/index.md).
1010

1111
To keep the submission process smooth, please follow these guidelines:
1212

13-
1. Submit [a Pull Request (PR)](https://github.com/adamziel/blueprints/pulls) with your Blueprint.
14-
2. The PR must contain a single `blueprint.json` file under the path `blueprints/your-blueprint-name/blueprint.json` (like [the examples here](https://github.com/adamziel/blueprints/tree/trunk/blueprints)).
15-
3. Include all static files (WXR, ZIP, JPG, etc.) listed in the Blueprint in the submitted directory of your PR, and reference them via the `https://raw.githubusercontent.com` domain.
16-
4. By submitting a Blueprint, you agree to license it under [GPLv2 or later license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
13+
Submit [a Pull Request (PR)](https://github.com/adamziel/blueprints/pulls) with your Blueprint.
14+
15+
The PR should contain:
16+
17+
* A single `blueprint.json` file under the path `blueprints/your-blueprint-name/blueprint.json` (like [the examples here](https://github.com/adamziel/blueprints/tree/trunk/blueprints)).
18+
* All the static files (WXR, ZIP, JPG, etc.) your Blueprint references. The static files must be loaded via the `https://raw.githubusercontent.com` URL pointing to your branch.
19+
20+
For example, if you want to load `a content-export.xml` file and your branch is called `woocommerce-subscriptions`, then your PR must contain a:
21+
22+
* A `blueprints/woocommerce-subscriptions/blueprint.json` file
23+
* A `blueprints/woocommerce-subscription/content-export.xml` file the Blueprint should reference as follows:
24+
25+
```json
26+
{
27+
"steps": [
28+
{
29+
"step": "importWxr",
30+
"file": {
31+
"resource": "url",
32+
"url": "https://raw.githubusercontent.com/adamziel/blueprints/woocommerce-subscriptions/content-export.xml"
33+
}
34+
}
35+
]
36+
}
37+
```
38+
39+
By submitting a Blueprint, you agree to license it under [GPLv2 or later license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).
1740

1841
Make sure to correctly indent your Blueprints using tabs using a code formatter like [Prettier](https://prettier.io/) – this repository ships a `.prettierrc` file you could use. This is mostly to help the reviewers understand your Blueprint better. Every accepted and merged Blueprint will automatically be re-formatted using the `.prettierrc` file.
1942

0 commit comments

Comments
 (0)