Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.79 KB

CONTRIBUTING to create-guten-block

First of all, I'd like to welcome you for thinking about contributing to this project. I'd rather explain the flow of this project and explain all that in a later release (as right now I am focused at an early release).

🔥 TL;DR

  • Git Clone git clone https://github.com/ahmadawais/create-guten-block/
  • yarn
  • yarn create-guten-block demo-block
  • yarn updated

📖 Details

  • git clone https://github.com/ahmadawais/create-guten-block/
  • yarn or sudo yarn
    • Installs all the node packages and deps/devDeps in all the workspaces.
  • yarn create-guten-block demo-block
    • This will run tasks/cgb.js file
    • Which will run ./packages/create-guten-block/index.js
    • And your new block plugin called demo-block gets added at the root of this project (which you should delete after testing).
  • Now go to cd demo-block
  • Run npm start or yarn start
  • This will compile your code in dist and you're good to go.
  • Run yarn updated to check which npm packages were updated
  • Finally publish with 'yarn publishNPM' since yarn has some issues with publishing with lerna not sure why.
  • Check caveats for publishing.

🤔 Caveats

  • Some issue with yarn not being able to publish via lerna
  • Use yarn with everything else but lerna
  • To publish always run via npm this command npm run lerna (Only for maintainers)

🐵 Other Stuff

  • Use // @remove-file-on-eject to do just that.
  • Use // @remove-on-eject-begin to do just that.
  • Use // @remove-on-eject-end to do just that.

🌟 Always use AA Git Commit Log Messages

What is that? I like emoji and I have invented a way to keep the git log clean and simple. Read this AA Git Commit Log to learn more.