Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 1.83 KB

CONTRIBUTING_DOCUMENTATION.md

File metadata and controls

57 lines (41 loc) · 1.83 KB
Raw

Contributing to Clarity Documentation

The Clarity documentation is located at clarity.design. The documentation site documents all aspects of Clarity which includes the following:

  • Design Guidelines
  • Accessibility Guidelines
  • Angular Component Usage
  • Web Component Usage

To add new documentation or fix existing documentation you will need to run our development environment on your computer. You will need to have NodeJS preinstalled as well as Git Source Control.

  1. Fork the Clarity Repository using you Github account.

  2. Clone the Clarity Repository

    ## Clone your forked repository
git clone [email protected]:<github username>/clarity.git

## Navigate to the directory
cd clarity

## Set name and e-mail configuration
git config user.name "John Doe"
git config user.email [email protected]

## Setup the upstream remote
git remote add upstream https://github.com/vmware/clarity.git

## Check out the upstream a topic branch for your changes
git fetch
git checkout -b topic/feature-name upstream/topic/feature-name

  3. Install Clarity Dependencies

    npm install

  4. Start the Website

    npm run website:start

  5. See changes in your browser at localhost:4200

The source code for the Clarity Documentation is located in the src/website folder. Once you have made the changes and are happy with the results you can submit and open a Pull Request by following our Development Contribution Guidelines.