Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

21 lines (18 loc) · 1.2 KB

Contributing

Thank you for your interest in contributing! Feel free to put up a PR for any issue or feature request. Please follow blow steps to begin your contribution :)

Setup

  1. Fork the repo
  2. Clone your fork
  3. Make a branch for your bug fix or feature
  4. Run npm use
  5. Run npm install
  6. Run npm run build to see how babel-module plugin works (see dist/src for the transpiled code)
  7. Work your magic and make your changes
  8. Run npm run demo to make sure our transpiled code is not is broken
  9. Add yourself to the contributor's list in the README
  • npm run add -- <username> <contribution> (Current project follows the all-contributors specification)
  1. Commit your changes and reference the issue/feature you're addressing (for example: git commit -am 'Commit message. Closes #1')
  2. Push your branch to your fork
  3. Create a pull request from your branch on your fork to master on this repo
  4. Have your branch get merged in and celebrate 🎉 🎊

If you experience any issues or problems at any point, please don't hesitate to file an issue or send me a message!