Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 2.69 KB

README_DEVELOPERS.md

File metadata and controls

50 lines (29 loc) · 2.69 KB
Raw

README for Developers

We use the Fork-and-Branch workflow. Start with forking the repository, then create a branch to which you commit modifications.

Do not clone the main repository

Create a pull request to the master branch when you are ready to submit your changes. Each pull request should pass all automatic checks and at least one member of the DevExtreme team should review it.

Make sure that you properly configure your Git username and email.

Install Required Software

To set up a build environment, you need the following software installed:

  • Node.js and yarn (or npm). We recommend the LTS versions.
  • A web browser for development. We recommend Google Chrome.

Building

Run the following command to install packages:

yarn

or

npm install

After installation, the following commands are available:

  • yarn lint or npm run lint - Executes linters

  • yarn test or npm run test - Runs tests

  • yarn test:watch or npm run test:watch - Runs an interactive test watcher

  • yarn build or npm run build - Builds DevExtreme Reactive

  • yarn build:watch or npm run build:watch - Builds DevExtreme Reactive in watch mode and runs demos. The following demo URLs are accessible:

    • http://localhost:3002/ - Grid demos
    • http://localhost:3004/ - Chart demos
    • http://localhost:3005/ - Scheduler demos

We use a monorepo, and you can execute the described commands from individual packages (./packages/dx-react-core/, ./packages/dx-react-grid/, and so on).

Tests and CI

We adhere to the test-driven development paradigm. It follows a simple rule: each PR should contain a test if possible. It means that if a PR fixes a bug, it should contain a regression test; if a PR implements a new functionality, it should contain tests for it, and so on.

We recommend running tests and executing linters locally before you submit a PR.

Commit Message & Pull Request Title Guidelines

We use the Conventional Commits specification for commit messages and PR titles. You should make sure that your PR also follows it.