React plays Readme discussion #55
|
Tapas sir, I was assigned to make readme files for each of the play, so can I use any of the dependencies out there which makes an automatic readme or Do I have to manually make a readme for each play
|
Replies: 1 comment 21 replies
|
The automation is already in place. We are using PlopJS which automates the file creation for us. You can take a look into the https://github.com/atapas/react-play/blob/main/plopfile.js file's action section to learn how are we creating some of the play files already. Similarly, we need to create a |
|
ok. |
|
Tapas sir, I've raised the pr and in this one i've made sure that no yarn.lock & package.json file is added |
|
@hasnainmakada-99 Don't commit any files related to sample play as we do not need them in production. We just need the hbs file and the plop js file. |
|
ok sir, i've done it |
|
please review it |
Hey @hasnainmakada-99
The automation is already in place. We are using PlopJS which automates the file creation for us. You can take a look into the https://github.com/atapas/react-play/blob/main/plopfile.js file's action section to learn how are we creating some of the play files already.
Similarly, we need to create a
Readme.mdfile under each of the play folders when we create the component for it. The Readme file should have only one Heading with the play name. Let me know if you have questions. Happy to answer.