Skip to content

Developer Guide

Greg Smith edited this page Apr 6, 2019 · 32 revisions

Getting Started

  1. Clone this repository to your local machine

    git clone https://github.com/SAP/fundamental-react.git
    
  2. Navigate to the directory

    cd fundamental-react
    
  3. Install dependencies

    npm install
    
  4. Run in development mode

    npm start
    

Open http://localhost:3000 to view it in the browser.

Testing

npm run test
npm run test:coverage

Linting

npm run lint

Pull Requests

When authoring a change, create a pull request with the title beginning with one of the prefixes listed below:

  • fix:
    • bug fixes in the distribution package code
    • will increment the patch version
    • will show up in the Bug Fixes section in the release notes
  • feat: new features in the distribution package code
  • docs: any changes to the documentation pages/content (fixes or features)
  • chore: infrastructure/internal changes that don’t affect the distribution package code or the documentation pages/content

When merging a pull request, make sure the title of the merge commit starts with one of those prefixes. This is used by standard-version to increment the package version and update the CHANGELOG.md file and is also used to generate release notes when publishing releases.

Clone this wiki locally