From 1883da8b1d10847a34ef882192ba30c0df12f161 Mon Sep 17 00:00:00 2001 From: Tapas Adhikary Date: Mon, 4 Apr 2022 15:29:04 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20More=20doc=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CREATE-PLAY.md | 89 ++++++++++++++++++++++++++++++++++++++++++++++++-- plopfile.js | 12 +++---- 2 files changed, 93 insertions(+), 8 deletions(-) diff --git a/CREATE-PLAY.md b/CREATE-PLAY.md index d1ac2716c..fbf260981 100644 --- a/CREATE-PLAY.md +++ b/CREATE-PLAY.md @@ -2,12 +2,15 @@ ## Table of Contents - [Steps to Create a Play](#steps-to-create-a-play) +- [Submitting a Play for Review](submitting-a-play-for-review) - [Learn about the behind scenes](#learn-about-the-behind-scenes) - [Frequently Asked Questions](#faq) ### Steps to Create a Play Welcome developers! Here are some things you can do to get started with your `Play` creation. +> **Note:** The steps below assumes that you have forked and cloned the [react-play](https://github.com/atapas/react-play) repository. + - Open a command prompt in your project folder. - Run the following command: ```shell @@ -23,8 +26,82 @@ Welcome developers! Here are some things you can do to get started with your `Pl

plop create

- Please find the description of each of the questions in the table below. - + +
+ + Please expand to find the description of the question details. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
QuestionMandatoryDescription
Give us a play idYesA play id is an unique id for your play. Please provide any string starts with pl and without a space(Example: pl-id-card)
Please provide the name of the playYesPlease provide a meaningful name of the play(Example: Identity Card). This name will be visible to the users.
Tell us more about the playNoIt is a description of the play for users to understand it better. The maximum number of allowed characters is 1024.
Provide the React Component nameYesPlease provide the React component name for the play. This component will be created automatically. Please follow the convention of the React component name, example: IdentityCard
Provide the folder nameYesA folder name is required to create a separate folder for a play. It also helps in creating the deep linking path to access the play in the UI. Please provide a folder name, example: identity-card
Please provide the path(URL) to cover imageNoA cover image is used to show your play with a thumbnail in the play list page. Please provide a link a cover image that is publicly accessible using a URL, example: https://res.cloudinary.com/atapas/image/upload/v1649060528/demos/id-card_pdvyvz.png. Alternatively, you can have a cover.png file in the root of your play folder. + If you don't have a cover image, the app will use the default cover image.
What is the level of this play?YesYou will be asked to select one of the three levels, Beginner, Intermediate, or Advanced. Please select a level for the play. A level indicates the possible complexity of developing the play using React.
Provide maximum of 5 tagsNoPlease provide comma-separated list of tags. You can provide max 5 tags. Example: JSX, Hooks
Enter your github usernameYesProvide your GitHub user name to mark you as the creator of the play.
Enter your blog urlNoIf you have written an article about this play, please provide the link to your blog article page.
Enter your video urlNoIf you have created a video tutorial about this play, please provide the link to your YouTube video.
+

+ +
- Now you can run the app using the following command: ```shell @@ -34,6 +111,14 @@ Welcome developers! Here are some things you can do to get started with your `Pl ``` - You can now see your play added to the [play board](http://localhost:3000/plays) page. You can click on the play thumbnail to see the details of the play. +- Now start coding yor `Play`! +### Submitting a Play for Review +After you done with coding for your `Play`, you can submit it for review. Submitting a `Play` for review is a two step process. + +- Create a Pull Request on the [react-play](https://github.com/atapas/react-play) repository with your changes. +- Dedicate some time in a week to take care of the review comments. + +Once the Pull Request is approved and merged, we will notify you and add you as a `Contributor` to the [react-play](https://github.com/atapas/react-play) project. ### Learn about the behind scenes TBA diff --git a/plopfile.js b/plopfile.js index a56c6c014..7437da148 100644 --- a/plopfile.js +++ b/plopfile.js @@ -17,7 +17,7 @@ module.exports = plop => { { type: 'input', name: 'description', - message: 'Tell us more about the demo(Max 1024 characters):', + message: 'Tell us more about the play(Max 1024 characters):', }, { type: 'input', @@ -38,28 +38,28 @@ module.exports = plop => { { type: 'list', name: 'level', - message: 'What level is this play?(Example: Intermediate):', + message: 'What is the level of this play?(Example: Intermediate):', choices: ['Beginner', 'Intermediate', 'Advanced'] }, { type: 'input', name: 'tags', - message: 'Provide the tags(Example: JSX, Hooks):', + message: 'Provide maximum of 5 tags(Example: JSX, Hooks):', }, { type: 'input', name: 'github', - message: 'Your github username(Example: atapas):', + message: 'Enter your github username(Example: atapas):', }, { type: 'input', name: 'blog', - message: 'Your blog url(Example: https://blog.greenroots.info):', + message: 'Enter your blog url(Example: https://blog.greenroots.info):', }, { type: 'input', name: 'video', - message: 'Your video url(Example: https://www.youtube.com/watch?v=dQw4w9WgXcQ):', + message: 'Enter your video url(Example: https://www.youtube.com/watch?v=dQw4w9WgXcQ):', }, ], actions: [