From 1466bfb8baefe8e884996492043e88993be05a25 Mon Sep 17 00:00:00 2001 From: Birgit Pauli-Haack Date: Mon, 22 Apr 2024 09:54:29 +0200 Subject: [PATCH 1/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 496bc94..2b1de35 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Not sure how? Check out the [Blueprints 101](./docs/index.md). To keep the submission process smooth, please follow these guidelines: -Submit [a Pull Request (PR)](https://github.com/adamziel/blueprints/pulls) with your Blueprint. +Submit [a Pull Request (PR)](https://github.com/adamziel/blueprints/pulls) with your Blueprint. Consult this page [Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) if you need a refresher on the process. The PR should contain: From dd3eae1f370c702105c3ea7fa4c9aea2889e128a Mon Sep 17 00:00:00 2001 From: Birgit Pauli-Haack Date: Tue, 23 Apr 2024 10:15:42 +0200 Subject: [PATCH 2/4] Update the example solved #37 --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b1de35..a5652f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,10 +17,13 @@ The PR should 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)). * 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. `raw.githubusercontent.com` is a service that allows you to serve files directly from your GitHub repository. This is useful for loading static files in Blueprints. The URLs follow the `raw.githubusercontent.com/${user}/${repo}/${branch}/${path}` pattern. -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: +For example, if you want to load a content-export.xml file, you create a new folder in the blueprints directory, /woocommerce-subscription (the name should correpont to the name of the blueprint and must hold two files. * A `blueprints/woocommerce-subscriptions/blueprint.json` file -* A `blueprints/woocommerce-subscription/content-export.xml` file the Blueprint should reference as follows: +* A `blueprints/woocommerce-subscription/content-export.xml` file +* The branch is named `/woo-subscription/` + +Then the Blueprint should reference as follows: ```json { @@ -29,7 +32,7 @@ For example, if you want to load `a content-export.xml` file and your branch is "step": "importWxr", "file": { "resource": "url", - "url": "https://raw.githubusercontent.com/adamziel/blueprints/woocommerce-subscriptions/blueprints/woocommerce-subscriptions/content-export.xml" + "url": "https://raw.githubusercontent.com/adamziel/blueprints/woo-subscriptions/blueprints/woocommerce-subscriptions/content-export.xml" } } ] @@ -38,7 +41,7 @@ For example, if you want to load `a content-export.xml` file and your branch is 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). -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. +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. ## Blueprint metadata From 3866af8c202a091fea85568add967dc2bc83a02f Mon Sep 17 00:00:00 2001 From: Birgit Pauli-Haack Date: Tue, 23 Apr 2024 16:08:24 +0200 Subject: [PATCH 3/4] Update CONTRIBUTING.md Co-authored-by: Adam Zielinski --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5652f6..746b2ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,9 +21,8 @@ For example, if you want to load a content-export.xml file, you create a new fol * A `blueprints/woocommerce-subscriptions/blueprint.json` file * A `blueprints/woocommerce-subscription/content-export.xml` file -* The branch is named `/woo-subscription/` -Then the Blueprint should reference as follows: +Assuming your branch is named `/woo-subscription/`, the Blueprint should reference as follows: ```json { From 382acd2a56c31e6090baf75a6c36a6c7ed9f18e9 Mon Sep 17 00:00:00 2001 From: Birgit Pauli-Haack Date: Tue, 23 Apr 2024 16:09:11 +0200 Subject: [PATCH 4/4] Update CONTRIBUTING.md Co-authored-by: Adam Zielinski --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 746b2ca..14fc8e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ The PR should 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)). * 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. `raw.githubusercontent.com` is a service that allows you to serve files directly from your GitHub repository. This is useful for loading static files in Blueprints. The URLs follow the `raw.githubusercontent.com/${user}/${repo}/${branch}/${path}` pattern. -For example, if you want to load a content-export.xml file, you create a new folder in the blueprints directory, /woocommerce-subscription (the name should correpont to the name of the blueprint and must hold two files. +For example, if you want to load a content-export.xml file, you create a new folder in the blueprints directory, /woocommerce-subscription (the name should correpond to the name of the blueprint). The folder must hold two files: * A `blueprints/woocommerce-subscriptions/blueprint.json` file * A `blueprints/woocommerce-subscription/content-export.xml` file