Home

Contributing

• Styleguide - documentation around how the source code should be styled.

Generic Functionality

HelixUI should be built in a way that any component can be use in any web application. As such, you should avoid implementing any business logic (no API calls, no permission/authorization logic, no URLs, etc.) into new features.

Semantic Versioning

<Major>.<Minor>.<Patch>[-<Revision>]

• Major: Breaking Change
  • A developer will need to modify their application code to consume new APIs.
• Minor: New Feature
  • Library assets should be backward-compatible with existing application code.
  • A developer may need to modify their application code to address bug fixes shipped alongside new features.
• Patch: Bug Fixes
  • A developer may need to modify their application code to address a correction in the library APIs.
• Revision: same-day bug fix (optional)
  • A developer may need to modify their application code to address a correction in the library APIs.

Reference

NOTE: these should be moved to proper API docs at some point.

• Position Utility
• Writing Documentation