The Arctic Ice Studio JavaScript Code Style.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
assets
src
.editorconfig
.gitattributes
.gitignore
.npmrc
.remarkignore
.remarkrc.js
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README.md
package.json

README.md

The Arctic Ice Studio JavaScript Code Style based on the Airbnb JavaScript Style Guide.


Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style.

A style guide establishes and enforces style to improve the intelligibility and communication within the project community. It ensures consistency and enforces best practice in usage and language composition.

Getting Started

The project documentation contains chapters to learn about the comprehensive base rule set including ECMAScript +6 (ES 2015+) and React specific styles like e.g. Higher-Order Components, the component methods & properties ordering and props.

The development chapters contain information about the requirements, how to build this style guide documentation and run the tests.

To make sure your code matches this style guide use the official eslint-config-arcticicestudio-base extensible code linter configuration for ESLint. Use the advanced eslint-config-arcticicestudio package to also get support for the React and JSX A11Y specific rules.

Contributing

Read the contributing guide to learn about the development process and how to propose enhancement suggestions and report bugs, how to submit pull requests and the project's styleguides, branch organization and versioning model.

The guide also includes information about minimal, complete, and verifiable examples and other ways to contribute to the project like improving existing issues and giving feedback on issues and pull requests.

Copyright © 2018-present Arctic Ice Studio & Sven Greb