Conventions

In working with the framework, you will find a number of common conventions that are meant to make your life easier.

Project Names

The common project naming convention as been to suggest cui-{type}-{clientAcronym}; for example, cui-idm-acme or cui-i18n-acme or *cui-styleguide-acme

By using this convention, you'll know right away that the project is a CUI framework project, it is an idm based solution and for the ACME client.

Coding Style

Angular Style Guide

The John Pappa Angular Styleguide is a starting point for Angular development teams to provide consistency through good practices.

JavaScript Styleguide

Provided by the good folks at AirBnB this JavaScript Styelguide is a mostly reasonable approach to JavaScript providing fundamental best practices when writing great code.

BEM CSS Naming Conventions

BEM – Block Element Modifier is a methodology, that helps you to achieve reusable components and code sharing in the front-end.

Keep a changelog

CHANGELOG.md should be used in each project to track a human readable, friendly, summarized list of modifications per release version. These CHANGELOGs can then be utilized downstream by other documentation subscribers and other developers. Its just a good idea, and beside, your project managers will probably ask for summaries of your releases anyway so why not document them in this fashion consistently with convention.

Versioning

Semantic Versioning

Under the semantic versioning scheme, version numbers and the way they change convey meaning about the underlying code and what has been modified from one version to the next.

Repository Management

Keep your project in a git based repository if you can. Host it wherever you like (Gitlab, GitHub, Bitbucket, etc.) but seriously, use git as the basis if you can.

Take advantage of forks and branches, they won't bite and it really makes life a lot easier for your release manager!

results matching ""

    No results matching ""