Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
22 lines (13 loc) · 791 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (13 loc) · 791 Bytes

Contributing

Style guide

  • Please use Conventional Commit messages.
    • For the scope, please reference the issue number your commit is addressing. e.g., "feat(#12): add descriptions to instruction generator functions"

Testing

  • Please write tests for new code that you create! We use Jest and Enzyme.

Local Development

Running a production-style build:

  1. Run npm run build.
  2. In a browser, open the dist/index.html file that was generated by the previous step.

Running a dev build (with watch mode):

  1. Run npm run build-dev.
  2. In a browser, open the dist/index.html file that was generated by the previous step. After making changes to the code, you will need to refresh the page in your browser to see your changes.
⚡