Home - HelixDesignSystem/helix-ui GitHub Wiki

• Setup
• Tech Stack
• Licensing
• Standards
• Guides
• Resources

---

Thank you for your interest in contributing to HelixUI. Below you should find everything you need to get started.

Setup

REQUIRED -- Install the necessary dependencies to get your local development environment up and running.

Quick Start:

0. Clone the repo with git clone [email protected]:rackerlabs/helix-ui.git
1. install yarn
2. install test dependencies
3. yarn install to install project dependencies
4. yarn start to begin working

Read the Setup guide for more advanced setup instructions.

Tech Stack

REQUIRED -- Learn how HelixUI works.

• Custom Elements
• Nunjucks
• Testing Guidelines
• Release Process

Licensing

REQUIRED -- Given that HelixUI is an open source project, there are two main rules to follow:

1. Contributions must be compatible with the Apache 2.0 license.
2. Contributions must not contain any information that is confidential to Rackspace.

Pull requests that violate either of these rules will not be accepted.

Standards

REQUIRED -- Follow these rules when writing code.

• Styleguide
  • Common Standards
  • CSS Styleguide
  • HTML Styleguide
  • JavaScript Styleguide
  • Documentation Styleguide

Guides

Recommended -- Learning about these topics will help you create higher quality content and gain a deeper understanding of web development concepts.

• Accessibility
• Framework Compatibility
• Glossary

Resources

Recommended -- Below are some additional resources that will help you gain higher mastery of concepts, techniques, and technologies documented in this wiki.

• @intenttoship - Announcements for features that browser manufacturers intend to ship
• WebKit Status - Rendering engine used by Safari.