Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#36)
Browse files Browse the repository at this point in the history
Added link to the GitHub page on [how to create 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)

---------

Co-authored-by: Adam Zielinski <[email protected]>
  • Loading branch information
bph and adamziel authored Apr 23, 2024
1 parent 0b0501a commit cd2f92e
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,19 @@ 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:

* 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 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 the Blueprint should reference as follows:
* A `blueprints/woocommerce-subscription/content-export.xml` file

Assuming your branch is named `/woo-subscription/`, the Blueprint should reference as follows:

```json
{
Expand All @@ -29,7 +31,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"
}
}
]
Expand All @@ -38,7 +40,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

Expand Down

0 comments on commit cd2f92e

Please sign in to comment.