Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.5 KB

Contribute to Schematik Forms

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.

If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take over it but you should still leave a comment.

Getting started

Prerequisites

  • You have Node installed at v11+ and yarn installed at v1+
  • You understand git and github

Development Workflow

After cloning Schematik Forms, run yarn install to install the dependencies. Then the following commands will become available.

  • yarn start starts a dev server with the cypress fixtures.
  • yarn lint checks code style.
  • yarn test runs the test suite.
  • yarn test:unit runs the unit tests with jest.
  • yarn test:cypress runs the cypress tests.
  • yarn cypress:open Starts cypress in interactive mode.
  • yarn docs Creates the table of contents for the readme file

Building the library

Run yarn build to build the library. The build will output to /lib.

Submitting Pull Requests

The core maintainers monitor pull request's whom will perform the reviews.

Before submitting a pull request please ensure the following is done:

  • Fork the repository and create your branch from master.
  • If you've fixed a bug or added a feature, add tests.
  • Ensure the tests pass (yarn test).