Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

95 lines (59 loc) · 3.35 KB

Contributing Guidelines

The repository is a place for all Front End Developers to join the UI Developement at Scania. It is us together that develop and maintain this repository as well as the documentation.

  • Something broken in a existing component? Help fixing it!
  • Found a component that needs to be extended? Get on and improve it!
  • Missing out on a component? Develop it!

Coding Standard

We're contributing, and are following, the coding standards available at https://github.com/scania/coding-conventions.

Report an issue

Opening a pull request

  1. Fork the repository and clone it locally

    # Clone your fork of the repo 
git clone https://github.com/<your-github-username>/sdds.git

  2. Sync your local to the original “upstream” repository by adding it as a remote. Pull in changes from “upstream” often so that you stay up to date so that when you submit your pull request, merge conflicts will be less likely. Read more here.

    # Navigate to the newly cloned repo
cd sdds

# Connect to the original "upstream" repo
git remote add upstream https://github.com/scania-digital-design-system/sdds.git

  3. Create a branch for your edit. To pass travis build process, only create a branch name under one of these labels:

    • improvement/ for improvement changes
    • feature/ for a feature solution
    • bug/ for bug fixes

    For example, if you want to create a bug fix, the branch name will be bug/fix_for_something.

    To create a branch, run the following command:

    git checkout -b <branch-name>

  4. Refers to any relevant issues in the pull request. For example, write Fixes #xxx in the commit message to refers to a specific issue.

  5. Open a pull request and write clear title and description in the pull request interface. In the right side of the screen, assign yourself in the pull request and add the correct label. You can also add a reviewer from SDDS team.

Developing Components

Prerequisites

  • Download and install node.js: https://nodejs.org/en/

    NodeJS: use 8.15 or newer stable version of node

  • If you're behind a firewall, CONFIGURE THE PROXY

Getting the code

This project is using lerna to manage all different SDDS packages on this repo.

  • Clone the SDDS repo and install package dependencies:
git clone https://github.com/scania-digital-design-system/sdds.git
cd sdds
npm i

Running demo and sync with theme project

Run the following command:

cd sdds
npm start

It will start demo and run storybook to preview your components. Add stories to preview in storybook. See components/header/header.stories.js for stories example. Visit http://localhost:1339/

Running test

Testing the components is done using the Stencil testing setup that includes unit test and End-to-End test. To test locally run npm test