Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

76 lines (45 loc) · 2.81 KB
Raw

Contributing/Developing

Using Apple Silicon M1?

For users running on Apple Silicon M1, you may encounter errors thrown by sharp. You may need to re-install libvps or to build sharp manually following this issue comment in order to start the project.

Prerequisites

First, check if you're using the required versions of Node.js and npm.

The easiest (and at this point in time the best way) to develop this plugin is by adding it to an existing project by placing it into /plugins folder. The below steps will help you to set up this on a fresh project, if you would like to add it to your project, omit the first 2 steps and start with step 3.

1. Fork a fresh Strapi (Playground) project repository

2. Clone the Playground your computer

replace YOUR_USERNAME with your username 🙂

git clone [email protected]:YOUR_USERNAME/strapi-playground.git

3. Fork the plugin repository

4. Clone Strapi Plugin Migrate to your project's /plugins folder.

replace YOUR_USERNAME with your username 🙂

mkdir plugins && cd plugins && git clone [email protected]:YOUR_USERNAME/strapi-plugin-migrate.git migrate

If you are cloning to an existing project with an existing plugins folder, omit the mkdir plugins

5. Prepare the app and the Admin UI

You'll need to rebuild admin UI and start development from Strapi root folder.

cd .. && yarn && yarn build --clean && strapi develop --watch-admin

6. Develop

From here on you are good to go - make changes to files in the /plugins/migrate folder and they will be reflected in the browser.

Naming routes

Internal plugin routes for RESTful requests should follow this pattern:

/TARGET_TYPE/EXPORT_TYPE/ACTION_TYPE

For example:

/user-permissions/json/export

Organizing routes

We sort our routes by type. So when adding new routes we look at the block where the specific TARGET_TYPE is located and insert the snippet where seems appropriate.

7. Creating a PR

When creating a PR, please make sure your code is clean, and you describe 1) what you are changing; 2) why you are changing; 3) what you are adding; 4) why you are adding - and so on. As many details as you can that will help reviewing the PR.

Thank you for considering to contribute!! 🙌