Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 1.55 KB
Raw

Contributing to preact-codemod

  1. Fork and clone this repository.
$ git clone [email protected]:vutran/preact-codemod.git
  1. Switch to the new preact-codemod directory that was created in step 1.
$ cd preact-codemod
  1. Install npm dependencies.
$ npm install
  1. Create a transform in the ./transforms directory.
  2. Create a test fixture in the ./__testfixtures__ directory.
  3. Create a test in the ./__tests__ directory.
  4. Submit a Pull Request if you have something great to contribute and a review will proceed.

Bug Reports

Found a bug? Submit it to the issue tracker and/or send a Pull Request so we can get it squashed.

Feature Requests

If you have an idea for a feature, please post them to the issues tracker and we can discuss. Not all features will be implemented.

Pull Requests

Make sure your transforms are accompanied by a test fixture and a test. Submit all Pull Requests to the master branch. If you have an idea and don't know if it will get accepted, please file an issue and we can discuss whether it could be merged into core.

Feedback and Suggestions

All feedback and suggestions for preact-codemod are welcomed. If you have one, please send a tweet to @tranvu and we can discuss.