Skip to content

Adaptavant/AW-Code-Standards

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 

Repository files navigation

Public AW-Code-Standards

This is Deprecated now and please check Here for latest

At AnywhereWorks, we believe that having good, automated quality checks of our code helps us work faster, more efficiently, and with less errors. This public (as in public to the entire world) repository contains AnywhereWorks' configuration for eslint and other code quality tools. To apply these standards to your own code, see the links to the instructions below.

Why Coding Standards And Linting Matters

Coding standards are a set of guidelines, best practices, programming styles and conventions that developers adhere to when writing source code for a project. Most of the top companies have them.

A coding standards document tells developers how they must write their code. Instead of each developer coding in their own preferred style, they will write all code to the standards outlined in the document. This makes sure that a large project is coded in a consistent style — parts are not written differently by different programmers. Not only does this solution make the code easier to understand, but it also ensures that any developer who looks at the code will know what to expect throughout the entire application.

The point of a coding style standard and code linting is not to say one style is objectively better than another in the sense of the specific details (75 characters and one-true-brace convention, for example). Instead, the point is to set up known expectations on how the code is going to look and to avoid problematic patterns or code that doesn't adhere to certain style guidelines.

So it's time for us to build our ecosystem together and help each other to have consistency in solid engineering practices in ourselves.

Style Guides

Note: this guide assumes you are using any build tools like for java Maven, Gradle and for Javascript WebPack, Gulp or Grunt.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published